List segments

Return the segments of your organization, each with its current total_persons count.

Endpoint

GET
/campaign-segments

Query parameters

NameTypeRequiredDescription
channelstringNowhatsapp, instagram, messenger, email, automation, sms or ai_calling.
builder_typestringNomanual or ai.
searchTermstringNoCase-insensitive search on name.
$limitintegerNoPage size. Default 10, max 50.
$skipintegerNoNumber of records to skip.
$sort[field]integerNo1 ascending, -1 descending. With searchTerm only name, channel, created_at, updated_at and id can be sorted.
$select[]stringNoReturn 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.