Contacts List

📘

Supported Regions and Base URLs

Scope

contacts:read

Body Response - Schema

200 (get a contact response)

ParameterTypeDescriptionRequired
totalintegern/ayes
_embeddedobject"_embedded" subdivides into:

"contacts (array[object]), which subdivides into:

1 - "id" (string) - contact ID (required)

2 - "name" (string) - contact name (required)

3 - "company" (string) - contact company (required)

4 - "phones" (array[object]) - contact company (required)
4.1 - "label" (string) - phone number label
4.2 - "number" (string) - phone number in E.164 format

5 - "_links" (object) - contact company (required)
5.1 - "self" (object)
5.1.1 - "href" (string) - default: https://api.talkdeskapp.com/contacts/:contact_id
5.2 - "integrations" (object)
5.2.1 - "href" (string) -default: https://api.talkdeskapp.com/contacts/:contact_id/integrations
yes
countintegern/ayes
_linksobject"_links" subdivides into:

1 - "self (object), which subdivides into:
1.1 - "href" (string) -default: https://api.talkdeskapp.com/contacts?page=:page&per_page=:per_page

2 - "prev (object), which subdivides into:
2.1 - "href" (string) -default: https://api.talkdeskapp.com/contacts?page=:page&per_page=:per_page

3 - "next (object), which subdivides into:
3.1 - "href" (string) -default: https://api.talkdeskapp.com/contacts?page=:page&per_page=:per_page
yes
Language