get https://api.talkdeskapp.com/contacts
Scope
contacts:read
Body Response - Schema
200 (get a contact response)
| Parameter | Type | Description | Required |
|---|---|---|---|
| total | integer | n/a | yes |
| _embedded | object | "_embedded" subdivides into: "contacts (array-0": "Pa), which subdivides into: 1 - "id" (string) - contact ID (required) 2 - "name" (string) - contact name (required) 3 - "company" (string) - contact company (required) 4 - "phones" (array "1-0": ) - 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_id5.2 - "integrations" (object) 5.2.1 - "href" (string) -default: https://api.talkdeskapp.com/contacts/:contact_id/integrations | yes |
| count | integer | n/a | yes |
| _links | object | "_links" subdivides into: 1 - "self (object), which subdivides into: 1.1 - "href" (string) -default: https://api.talkdeskapp.com/contacts?page=:page&per_page=:per_page2 - "prev (object), which subdivides into: 2.1 - "href" (string) -default: https://api.talkdeskapp.com/contacts?page=:page&per_page=:per_page3 - "next (object), which subdivides into: 3.1 - "href" (string) -default: https://api.talkdeskapp.com/contacts?page=:page&per_page=:per_page | yes |
Limit on the Number of Contacts You Can Retrieve
Talkdesk can only display 10 thousand contacts (Talkdesk displays 50 contacts per page, so the total limit is 10 thousand contacts).
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.