Contact by ID

📘

Supported Regions and Base URLs

Scope

contacts:read

Body Response - Schema

200 (get a contact response)

ParameterTypeDescriptionRequired
contactobject"contact" subdivides into:

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

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

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

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

5 - "_links" (object)
5.1 - "self" (object)
5.1.1 - "href" (object) - default: https://api.talkdeskapp.com/contacts/:contact_id
5.2 - "integrations" (object)
5.2.1 - "href" (object) - default: https://api.talkdeskapp.com/contacts/:contact_id/integrations
no

400 (contact not found)

ParameterTypeDescriptionRequired
codestringn/ayes
messagestringn/ayes
descriptionstringn/ano
fieldsarray[object]"fields" subdivides into:

"name" (string)

"description" (string)
yes (name and description)
Language
Click Try It! to start a request and see the response here!