v4

latestOpenAPI 3.1.0BSD-3-Clauseraw.githubusercontent.com2026-08-0154110202.6 KB
mcp

Retrieves all user segments defined for audience targeting within the project.

get/api/v1/projects/{project_pk}/segments/

Path parameters

project_pkinteger required

Query parameters

identitystring

Optionally provide the id of an identity to get only the segments they match

include_feature_specificboolean
pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

qstring

Search term to find segment with given term in their name

Response

countinteger required
nextstring uri nullable
previousstring uri nullable

Example response

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2"
}