List segments
Return the segments of your organization, each with its current total_persons count.
Endpoint
GET/campaign-segments
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
channel | string | No | whatsapp, instagram, messenger, email, automation, sms or ai_calling. |
builder_type | string | No | manual or ai. |
searchTerm | string | No | Case-insensitive search on name. |
$limit | integer | No | Page size. Default 10, max 50. |
$skip | integer | No | Number of records to skip. |
$sort[field] | integer | No | 1 ascending, -1 descending. With searchTerm only name, channel, created_at, updated_at and id can be sorted. |
$select[] | string | No | Return only these fields. |
Request
Response
json
Counting contacts runs the segment rules, so large pages of segments are slower than other lists.
Report an issue with this documentation
Please log in to report issues with our documentation.