Segments
Get all segments
Get a paginated list of all the created segments.
GET
/
segments
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Headers
x-fabric-tenant-id
string
requiredMerchant's 24-character tenant ID
x-fabric-channel-id
string
requiredThe sales channel ID.
x-client-id
string
The platform where the request is made.
x-fabric-request-id
string
A unique request ID.
Query Parameters
size
integer
default: 10The maximum number of records per page.
startCursor
string
Specifies the record from which the search will start, effectively skipping all records before this point.
sort
enum<string>
default: -updatedAtThe criteria to sort the results. Use the format {sort order}{field name}, where -
refers to a descending order and +
refers to an ascending order.
Available options:
-updatedAt
, +updatedAt
, -name
, +name
Response
200 - application/json
query
object
The pagination details.
data
object[]
The segments list.
Was this page helpful?