Sign in

v1

latestOpenAPI 3.0.2EULA2026-07-143221521.2 MB
Segments

Get all segments

Get information about segments as a list of all segments.

get/segments

Query parameters

countinteger

The number of records to return in API response.

⚠️ We recommended adjust the batch size based on processing time. Depending on the response time of the request. Default value of 100 records is used if count parameter is not set.

offsetinteger

The number of records from a collection to skip. Default value of 0 is used when parameter offset is not set.

sort_fieldstring

Name of the sorting parameter. You can sort by any of the first level parameters from the resource response. Response is sorted by the specified field.

sort_direction'ASC' | 'DESC'

Direction of sorting the response list.

segment_group_idsstring[]

List of the segment group IDs from the resource GET /segment-groups. In case you want to filter multiple options use array syntax : segment_group_ids[]=8bed991c68a470e7aaeffbf048&segment_group_ids[]=9cfe0a2d79b581f8bb5ffc059 Logic OR is used between values.

Headers

Accept-Languagestring

The unique ID of the language code by ISO 639-1.

Response

OK

Example response

{
  "data": {
    "segments": [
      {
        "segment_id": "82de12eb8b138791e678fd11c3",
        "name": "VIP customers",
        "segment_group_id": "8bed991c68a470e7aaeffbf048",
        "note": "VIP customers note test",
        "last_change": "2021-06-04 13:25:39"
      }
    ],
    "total_items": 1
  }
}