Get contacts list

get

https://api.talkdeskapp.com/contacts

The endpoint allows you to retrieve a list of contacts based on specific query parameters.
This endpoint provides a flexible and efficient way to retrieve contact information based on different criteria.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Scope

contacts:read

Query Params

ids

array of strings

length ≤ 50

Filter by 'Contact IDs'.

ids

name

string

Filter by 'Contact full name'.

name.loose

string

Filter by 'Contact full name' (loose matching).

company

string

Filter by 'Contact company name'.

company.loose

string

Filter by 'Contact company name' (loose matching).

integration

string

Filter by 'Integration name and external id'. The format to use is: integration_name:external_id where:

integration_name is the integration name.
external_id is the contact identifier in the integration.

Example: salesforce:123

emails

array of strings

Filter by 'Contact emails'

emails

phones

array of strings

Filter by 'Contact phone numbers' in E.164 format

phones

page

integer

≥ 1

Defaults to 1

Requested page number.

per_page

integer

1 to 50

Defaults to 50

Number of elements per page.

Response

Language

Credentials

OAuth2

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Scope

200Get a contact response