Contacts

Get single contact

Each contact has it's own identifier, so on, you can use it to fetch only single specific contact that you need.

get/contacts/{contactId}

Request

  • Base URL
    https://api.tidio.com
  • URL
    https://api.tidio.com/contacts/{contactId}
  • Auth
    API key in header X-Tidio-Openapi-Client-Id and API key in header X-Tidio-Openapi-Client-Secret

Path parameters

contactIdstring uuid required

ID of the contact

Example:a1b4ca4c-1108-4432-b256-1e4cf2bf6f9e

Response

Single contact

idstring uuid

ID of the contact

distinct_idstring nullable

ID of the contact in external system

first_namestring nullable

First name of the contact

last_namestring nullable

Last name of the contact

emailstring email nullable

Email address of the contact

phonestring nullable

Phone number of the contact

languagestring nullable

Language of the contact in ISO 639-1 format (lowercase)

countrystring nullable

Country of the contact in ISO 3166 Alpha-2 format (uppercase)

citystring nullable

City of the contact

messenger_idstring nullable

❗️ <strong>Deprecated:</strong> it always returns null. Will be removed in the next version.

Messenger ID of the contact

instagram_idstring nullable

❗️ <strong>Deprecated:</strong> it always returns null. Will be removed in the next version.

Instagram ID of the contact

created_atstring date-time

Creation date of the contact

email_consent'subscribed' | 'unsubscribed' nullable

This field indicates if contact agreed to newsletter subscription

Example response

{
  "id": "a1b4ca4c-1108-4432-b256-1e4cf2bf6f9e",
  "distinct_id": "123456",
  "first_name": "John",
  "last_name": "Doe",
  "email": "email@example.com",
  "phone": "123 456 789",
  "language": "en",
  "country": "US",
  "city": "New York",
  "created_at": "2023-01-01T00:00:00+00:00",
  "email_consent": "subscribed",
  "properties": [
    {
      "name": "shoe_size",
      "value": "44 (EU)"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.