Sign in
Reach: Segments

List profile segment contacts

Retrieve contacts associated with a specific segment for a given profile.

This endpoint allows you to fetch and filter contacts that belong to a particular segment, identified by its UUID, scoped to a specific profile.

get/api/reach/v1/profiles/{profileUuid}/segmentation/segments/{segmentUuid}/contacts

Path parameters

profileUuidstring required
Example:550e8400-e09b-41d4-a716-400055000000

Profile uuid parameter

segmentUuidstring required
Example:550e8400-e09b-41d4-a716-400055000000

Segment uuid parameter

Query parameters

pageinteger
Example:1

Page number

per_pageinteger
Example:25

Number of items per page

Response

Success response

Example response

{
  "data": [
    {
      "uuid": "550e8400-e29b-41d4-a716-446655440000",
      "name": "John",
      "surname": "Doe",
      "email": "john.doe@example.com",
      "subscription_status": "subscribed",
      "subscribed_at": "2023-01-01T00:00:00Z",
      "source": "sync",
      "note": "VIP customer"
    }
  ],
  "meta": {
    "current_page": 1,
    "per_page": 15,
    "total": 100
  }
}

Changes

Changed in 3 of the 88 revisions of this API.161

  • 967858ce3b896See the full diff
    • ●

      added the new api enum value to the data/items/source response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new checkout enum value to the data/items/source response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new confirmed enum value to the data/items/subscription_status response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new form enum value to the data/items/source response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new horizons enum value to the data/items/source response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new pending enum value to the data/items/subscription_status response property for the response status 200

      response-property-enum-value-added

  • 9594914201171See the full diff
    • ○

      endpoint added

      endpoint-added

  • d05574986eb11See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 124 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog