List profile contacts

Get a paginated list of contacts belonging to a profile.

List profile contacts

get

Get a paginated list of contacts belonging to a profile.

Contacts can be filtered by subscription status, by tag, and by an email search term. The meta.total field of the response is the number of contacts matching the filters, so calling this endpoint without filters gives the profile's total contact count.

Authorizations

AuthorizationstringRequired

API Token authentication

Path parameters

profileUuidstringRequired

Profile uuid parameter

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

Query parameters

subscription_statusstring · enumOptional

Filter contacts by subscription status

Example: subscribedPossible values:

tag_uuidstring · uuidOptional

Filter contacts by tag UUID

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

searchstring · max: 255Optional

Search contacts by email

Example: [e-mail]

pageintegerOptional

Page number

Example: 1

per_pageinteger · max: 100Optional

Number of items per page

Default: 25Example: 25

Responses

200

Success response

application/json

401

Unauthenticated response

application/json

500

Error response

application/json

get/api/reach/v1/profiles/{profileUuid}/contacts

GET /api/reach/v1/profiles/{profileUuid}/contacts HTTP/1.1
Host: developers.hostinger.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "uuid": "550e8400-e29b-41d4-a716-446655440000",
      "name": "John",
      "surname": "Doe",
      "email": "[e-mail]",
      "phone": "[phone]",
      "subscription_status": "subscribed",
      "subscribed_at": "2023-01-01T00:00:00Z",
      "unsubscribed_at": "2023-06-15T00:00:00Z",
      "source": "api",
      "note": "VIP customer"
    }
  ],
  "meta": {
    "current_page": 1,
    "per_page": 15,
    "total": 100
  }
}