customer-segments.md

Customer Segments

const customerSegmentsApi = client.customerSegmentsApi;

Class Name

CustomerSegmentsApi

Methods

• List Customer Segments
• Retrieve Customer Segment

List Customer Segments

Retrieves the list of customer segments of a business.

async listCustomerSegments(
  cursor?: string,
  limit?: number,
  requestOptions?: RequestOptions
): Promise<ApiResponse<ListCustomerSegmentsResponse>>

Parameters

Parameter	Type	Tags	Description
cursor	string | undefined	Query, Optional	A pagination cursor returned by previous calls to ListCustomerSegments. This cursor is used to retrieve the next set of query results. For more information, see Pagination.
limit	number | undefined	Query, Optional	The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results. If the specified limit is less than 1 or greater than 50, Square returns a 400 VALUE_TOO_LOW or 400 VALUE_TOO_HIGH error. The default value is 50. For more information, see Pagination.
requestOptions	RequestOptions | undefined	Optional	Pass additional request options.

Response Type

ListCustomerSegmentsResponse

Example Usage

try {
  const { result, ...httpResponse } = await customerSegmentsApi.listCustomerSegments();
  // Get more response info...
  // const { statusCode, headers } = httpResponse;
} catch(error) {
  if (error instanceof ApiError) {
    const errors = error.result;
    // const { statusCode, headers } = error;
  }
}

Retrieve Customer Segment

Retrieves a specific customer segment as identified by the segment_id value.

async retrieveCustomerSegment(
  segmentId: string,
  requestOptions?: RequestOptions
): Promise<ApiResponse<RetrieveCustomerSegmentResponse>>

Parameters

Parameter	Type	Tags	Description
segmentId	string	Template, Required	The Square-issued ID of the customer segment.
requestOptions	RequestOptions | undefined	Optional	Pass additional request options.

Response Type

RetrieveCustomerSegmentResponse

Example Usage

const segmentId = 'segment_id4';
try {
  const { result, ...httpResponse } = await customerSegmentsApi.retrieveCustomerSegment(segmentId);
  // Get more response info...
  // const { statusCode, headers } = httpResponse;
} catch(error) {
  if (error instanceof ApiError) {
    const errors = error.result;
    // const { statusCode, headers } = error;
  }
}