List Segment Configs

Returns a paginated list of segment configurations.

Each item carries the full config definition including segments and their rules. Filter by filter[name] (case-insensitive contains match on name). Order with sort — allowed fields: name, createdAt, updatedAt. Prefix the field with - for descending order. Use page[number] (1-based) and page[size] (default 25, max 200) to paginate.

Returns 200 with a paginated array of segment config resources and JSON:API pagination links. Returns 400 if filter, sort, or pagination parameters are invalid.

Query Params
string

Case-insensitive contains match on the segment config name.

int32
≥ 1
Defaults to 1

Page number for the results. Defaults to 1.

int32
1 to 200
Defaults to 25

Number of records to return per page. Default 25, maximum 200.

string

Field to sort by. Prefix with - for descending order. Allowed values: name, createdAt, updatedAt.

Responses

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