Get all segments
Get a paginated list of all the created segments.
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Headers
Merchant's 24-character tenant ID
The sales channel ID.
The platform where the request is made.
A unique request ID.
Query Parameters
The maximum number of records per page.
The number of records to skip before returning records. For example, with an offset of 20 and limit of 10, you will get records from 21 to 30.
The criteria to sort the results. Use the format {sort order}{field name}, where -
refers to a descending order and +
refers to an ascending order.
-updatedAt
, +updatedAt
, -name
, +name
Search for segments by partial match. It matches content in the name
field or any of the values in the values
array.
Response
Provides pagination data.
The segments list.
Was this page helpful?