Reach: Segments

List segment contacts

Changed on

Retrieve contacts associated with a specific segment.

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

Deprecated. This endpoint cannot target a profile, so it always falls back to the client's default profile and cannot read segments of any other profile. Use GET /api/reach/v1/profiles/{profileUuid}/segmentation/segments/{segmentUuid}/contacts instead.

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

Request

  • Base URL: https://developers.hostinger.com
  • URL: https://developers.hostinger.com/api/reach/v1/segmentation/segments/{segmentUuid}/contacts
  • Auth: HTTP bearer

Path parameters

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

  • 796bd5194565Revision changes
    • info

      endpoint deprecated

  • 967858ce3b89Revision changes
    • warning

      added the new api enum value to the // response property for the response status

    • warning

      added the new checkout enum value to the // response property for the response status

    • warning

      added the new confirmed enum value to the // response property for the response status

    • warning

      added the new form enum value to the // response property for the response status

    • warning

      added the new horizons enum value to the // response property for the response status

    • warning

      added the new pending enum value to the // response property for the response status