Returns a paginated list of segments that a contact belongs to.

Contact Identification

You can retrieve segments using various types of identifiers:

1. Customerly Contact ID (numeric):

• Use the internal contact ID directly (e.g., 29911301)
• Example: GET /contacts/29911301/segments

2. Custom User ID (prefix: cuid:):

• Your own custom identifier for a registered user
• Example: GET /contacts/cuid:user_123/segments

3. Custom Lead ID (prefix: clid:):

• Your own custom identifier for a lead
• Example: GET /contacts/clid:lead_456/segments

4. WhatsApp Number (prefix: wa:):

• The contact's WhatsApp number in E.164 format
• Example: GET /contacts/wa:+1234567890/segments

5. Email Address (prefix: uem: or lem:):

• For registered users: uem:[email protected] (User EMail)
• For leads: lem:[email protected] (Lead EMail)
• Example: GET /contacts/uem:[email protected]/segments

Pagination

This endpoint uses cursor-based pagination:

• per_page: Number of segments to return per page (default: 20, max: 100)
• cursor: The cursor value from the previous response to fetch the next page

Example pagination flow:

1. First request: GET /contacts/{id}/segments?per_page=20
2. Response returns a cursor value (e.g., 12345) and up to 20 segments
3. Next page: GET /contacts/{id}/segments?per_page=20&cursor=12345
4. Continue until cursor is null (no more segments available)

Response

Segments are ordered by segment entry ID in descending order (most recent first).
Each segment includes:

• contact_segment_id: Internal segment ID
• name: Segment name
• entry_date: Unix timestamp when the contact entered the segment