Segment
Get list of all segments
Retrieves a paginated list of segments based on query parameters.
GET
/
api-offers
/
segment
/
list
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Headers
x-site-context
string
requiredThe x-site-context
header is a JSON object that contains information about the source you wish to pull from. The mandatory account
is the 24 character identifier found in Copilot. The channel
(Sales channel ID), stage
(environment name), and date
attributes can be used to further narrow the scope of your data source.
Query Parameters
limit
number
The maximum number of records per page.
offset
number
The number of records to skip before returning records. For example, when offset is 20 and limit is 10, this endpoint returns records from 21 to 30.
Response
200 - application/json
query
object
Paging details used for selecting list
data
object[]
Segment information
Was this page helpful?