List a contact's segments

GET/api/v1/contacts/{id}/segments

GET /contacts/{id}/segments

curl -X GET 'https://www.unitpost.com/api/v1/contacts/con_123/segments' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0'

Response · 200

{
  "object": "list",
  "has_more": false,
  "data": [
    {
      "object": "contact_segment",
      "segment_id": "segment_123",
      "name": "Example",
      "type": "static",
      "subscribed": false,
      "unsubscribed_at": "2026-01-01T00:00:00.000Z"
    }
  ]
}

The segments the contact is in: static segments by membership, with its per-segment opt-out (subscribed), and dynamic segments whose filter it matches now. Not paginated. From the segment's side, see List segment members. The {id} accepts a contact id or email. Requires the contacts:read capability.

Parameters1 field

Field	Type	Description
`id`required	string · path	—

Response · 200 fields6 fields

Field	Type	Description
`object`required	string	—
`segment_id`required	string	—
`name`required	string	—
`type`required	enumstatic \| dynamic	A dynamic segment's members come from its filter; they can't be added or removed by hand.
`subscribed`required	boolean	Whether this segment's sends reach the contact (a static segment can be opted out of on its own).
`unsubscribed_at`required	string \| null	—

200401403404

List a contact's segments

List a contact's segments

Search docs and guides