Reach: Contacts

List contacts

Changed on

Get a list of contacts, optionally filtered by group and subscription status.

This endpoint returns a paginated list of contacts with their basic information. You can filter contacts by group UUID and subscription status.

Deprecated. This endpoint cannot target a profile, so it always falls back to the client's default profile and cannot list contacts of any other profile. Use GET /api/reach/v1/profiles/{profileUuid}/contacts instead, which also replaces the group filter with a tag filter.

get/api/reach/v1/contacts

Request

  • Base URL: https://developers.hostinger.com
  • URL: https://developers.hostinger.com/api/reach/v1/contacts
  • Auth: HTTP bearer

Query parameters

group_uuidstring
Example:550e8400-e29b-41d4-a716-446655440000

Filter contacts by group UUID

subscription_status'subscribed' | 'unsubscribed' | 'confirmed' | 'pending'
Example:subscribed

Filter contacts by subscription status

pageinteger
Example:1

Page number

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

  • 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

    • info

      endpoint deprecated

    • info

      added the new enum value confirmed to the query request parameter subscription_status

    • info

      added the new enum value pending to the query request parameter subscription_status