Skip to main content
GET
List All Segments
Pass a campaignId to get the segments of one campaign, and use filter for a free-text search.
For condition-based searches, use Query Segments.

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"

Path Parameters

campaignId
integer<int64>
required

The optional campaign ID to filter segments.

Query Parameters

Filter
string

A free-text search term. Only segments whose name, code, or description match the term are returned.

Skip
integer<int32>

The number of records to skip before the first record returned. Use it with take to page through the results.

Take
integer<int32>

The maximum number of records to return in this page of results.

SortBy
string

The field to sort the results by (case-insensitive).

Descending
boolean

The direction to sort the results. Set to true to sort in descending order.

IncludeDetails
boolean

When true, includes the related records for each item in the response. Not every list has extra records to return, and it can slow down large result sets.

Response

OK

A page of segments with the total number that match the request.

items
object[]

The segments in this page of results.

total
integer<int32>

The total number of segments that match the request. Use it with skip and take to page through the full set.

Last modified on July 28, 2026