Contacts
Get contacts
Contacts are site visitors who have interacted with the Tidio widget and have been identified by their name, email address, or phone number.
Each contact can have custom properties that can be given by the contact, added by chat operators, or updated by chatbots. Contacts may also have conversations, which include messages from the contact as well as messages to the contact from chat operators or chatbots.
You can list contacts with all their properties.
get/contacts
Request
- Base URLhttps://api.tidio.com
- URLhttps://api.tidio.com/contacts
- AuthAPI key in header X-Tidio-Openapi-Client-Id and API key in header X-Tidio-Openapi-Client-Secret
Query parameters
cursorstring
Example:aWRfX2U2YTgyYTc0LTExNzAtNGY1Ny1hMDMxLWIzNmYzZjZiYzA5Mw==
Value from the previous page. Use null to fetch the first one
emailstring email
Filter contacts by email address
Response
Paginated list of contacts
Example response
{
"contacts": [
{
"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)"
}
]
}
],
"meta": {
"cursor": "aWRfX2U2YTgyYTc0LTExNzAtNGY1Ny1hMDMxLWIzNmYzZjZiYzA5Mw==",
"limit": 1000
}
}Changes
No recorded changes to this operation across all 1 revision of this API.