v4

latestOpenAPI 3.1.02026-07-3163216290.7 KB

Audience segments

List audience segments

Retrieve a paginated list of audience segments, most recently created first.

get/v1/audience-segments

Query parameters

perPagestring

How many results to return in each request. Must be between 10 and 50. Default is 20.

cursorstring

A cursor to return a specific page of results. Cursors can be found from the pagination.nextCursor value in each response.

Response

Successful.

Example response

{
  "pagination": {
    "totalResults": 2,
    "returnedResults": 2,
    "perPage": 20,
    "totalPages": 1,
    "nextCursor": null,
    "nextPage": null
  },
  "data": [
    {
      "id": "cls6e8g0i2k4m6o8q0s2u4w6",
      "name": "Power users",
      "description": "Contacts on the pro plan",
      "createdAt": "2025-06-29T07:47:39.370Z",
      "updatedAt": "2025-06-29T07:47:39.370Z",
      "filter": {
        "match": "all",
        "conditions": [
          {
            "type": "property",
            "key": "plan",
            "operator": "equals",
            "value": "pro"
          }
        ]
      }
    }
  ]
}