Sign in

v1

latestOpenAPI 3.0.22026-07-2441902.6 MB
Contacts API

Get contacts list

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.

get/contacts

Query parameters

idsstring[]

Filter by 'Contact IDs'.

namestring

Filter by 'Contact full name'.

name.loosestring

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

companystring

Filter by 'Contact company name'.

company.loosestring

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

integrationstring

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

emailsstring[]

Filter by 'Contact emails'

phonesstring[]

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

pageinteger

Requested page number.

per_pageinteger

Number of elements per page.

Response

Get a contact response

totalinteger required
countinteger required

Example response

{
  "total": 3,
  "_embedded": {
    "contacts": [
      {
        "id": "f68519eb9e5047b59dbf1c0e",
        "name": "Daniel Craig",
        "company": "Talkdesk",
        "phones": [
          {
            "label": "Mobile",
            "number": "+351987654321"
          },
          {
            "label": "Business",
            "number": "+321212345678"
          }
        ],
        "_links": {
          "self": {
            "href": "https://api.talkdeskapp.com/contacts/f68519eb9e5047b59dbf1c0e"
          },
          "integrations": {
            "href": "https://api.talkdeskapp.com/contacts/f68519eb9e5047b59dbf1c0e/integrations"
          }
        }
      }
    ]
  },
  "count": 1,
  "_links": {
    "self": {
      "href": "https://api.talkdeskapp.com/contacts?page=2&per_page=1"
    },
    "prev": {
      "href": "https://api.talkdeskapp.com/contacts?page=1&per_page=1"
    },
    "next": {
      "href": "https://api.talkdeskapp.com/contacts?page=3&per_page=1"
    }
  }
}