Gets a list of segments

This endpoint returns a paginated list of all existing segment models.

You need the "View customers" permission to use this endpoint.

Query Params
string

Returns only segments with this exact name, ignoring case.

string
enum

Returns only segments with this status.

Allowed:
string
enum
deprecated

Deprecated: use segment_type. Ignored when segment_type is sent.

Allowed:
sort
array of strings

Field to sort by: one of segment_type, updated_at, name. Prefix with - for descending order.

sort
Allowed:
string
enum

Returns only segments of this type.

Allowed:
integer
≥ 1
Defaults to 1

One-based page index (1..N)

integer
≥ 1
Defaults to 50

The size of the page to be returned

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json