v4

OpenAPI 3.1.02026-07-3163216290.7 KB

Audience segments

Get an audience segment

Retrieve a single audience segment by ID.

get/v1/audience-segments/{audienceSegmentId}

Response

Successful.

idstring required

The ID of the audience segment.

namestring required

The name of the audience segment.

descriptionstring nullable required

An optional description of the audience segment.

createdAtstring required

ISO 8601 timestamp for when the audience segment was created.

updatedAtstring required

ISO 8601 timestamp for when the audience segment was last updated.

Example response

{
  "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"
      }
    ]
  }
}