Get contacts
Contacts are site visitors who interact with Tidio.
They may provide their name and email address. 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.
Query Parameters |
---|
cursor stringValue from the previous page. Use null to fetch the first one |
Responses |
---|
200
Paginated list of contacts Schema |
---|
contacts object[]id uuid | distinct_id stringID of the contact in external system | first_name stringFirst name of the contact | last_name string | email emailEmail address of the contact | phone stringPhone number of the contact | language stringLanguage of the contact in ISO 639-1 format (lowercase) | country stringCountry of the contact in ISO 3166 Alpha-2 format (uppercase) | city string | created_at date-timeCreation date of the contact | email_consent stringPossible values: [subscribed , unsubscribed ] This field indicates if contact agreed to newsletter subscription | properties object[]name stringPossible values: length ≤ 128 | value stringPossible values: length ≤ 1000 |
|
| meta objectcursor stringValue to fetch the next page. Null means the page is the last one. | limit integerHow many items were displayed on list |
|
|
Schema |
---|
errors object[]code Error code | message More specific description of the error |
|
|