<- Customer Segments API

Customer Segments API

All versions ->

List customer segments

GET

 /v2/customers/segments

Retrieves the list of customer segments of a business.

Permissions:CUSTOMERS_READ

Guide

List customer segments

Try in API Explorer
Link to section

Query parameters

Example code

Link to section

cursor

string

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.

Link to section

limit

integer(32-bit)

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.

Link to section

Response fields

Link to section

errors

Any errors that occurred during the request.

Link to section

segments

The list of customer segments belonging to the associated Square account.

Link to section

cursor

string

A pagination cursor to be used in subsequent calls to ListCustomerSegments to retrieve the next set of query results. The cursor is only present if the request succeeded and additional results are available.

For more information, see Pagination.