Sign in
Segments

List customers in a segment

Returns customers in a segment. This endpoint returns an array of identifiers; each object in the array represents a person and contains the identifier values allowed in your workspace. In general, we recommend that you use identifiers rather than ids to find people, because it provides more information.

If your workspace does not use email as a unique identifier for people, identifiers does not contain email values. Go to your Workspace Settings to find out which identifiers your workspace supports.

The ids array only lists ID values for people in a segment; if your workspace uses both email and id as identifiers, it's possible that a member of your segment does not have an id value, resulting in an empty string in the ids array.

get/v1/segments/{segment_id}/membership

Response

Returns an array of customers for a segment.

OR

Example response

{
  "segment_id": 7,
  "identifiers": [
    {
      "email": "test@example.com",
      "cio_id": "a3000001"
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.