get https://api.talkdeskapp.com/contacts/
Scope
contacts:read
Body Response - Schema
200 (get a contact response)
| Parameter | Type | Description | Required |
|---|---|---|---|
| contact | object | "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_id5.2 - "integrations" (object) 5.2.1 - "href" (object) - default: https://api.talkdeskapp.com/contacts/:contact_id/integrations | no |
400 (contact not found)
| Parameter | Type | Description | Required |
|---|---|---|---|
| code | string | n/a | yes |
| message | string | n/a | yes |
| description | string | n/a | no |
| fields | array[object] | "fields" subdivides into: "name" (string) "description" (string) | yes (name and description) |
Troubleshooting
If you have any questions regarding the usage of this API, or if you’re having any technical issues, please open a ticket using this form.