Skip to main content
GET
List segments
Use this endpoint to retrieve a paginated list of segments for the Segment tab, with optional search and status filters.

Endpoint

GET /segment/list Authentication: Required (workspace auth)

Query Parameters

Response

conditions/filters are parsed assuming the segment’s stored filter is in the CONDITIONLIST tree format written by Create Segment. A segment whose filter was subsequently changed via Update Segment (which stores a flat { field, operator, value } array instead) will show filters: 0 and an empty conditions array here, even though its filter is still applied when contacts are (re-)evaluated.

Example cURL

Headers

token
string
required

API token for authentication

Query Parameters

page
integer

Page number (default: 1)

limit
integer

Records per page (default: 10)

Partial match on segment_name (LIKE)

status
enum<integer>

0 = Inactive, 1 = Active. Deleted segments are always excluded.

Available options:
0,
1

Response

Segment list retrieved successfully

datalist
object[]
pagination
object