Contact -- Search

get

https://dialpad.com/api/v2/contacts/search

Searches local, shared, and lead contacts the API key may read within its company. All filters must match (AND). Contacts sharing an identifier are returned separately. Results may lag behind updates. A short or empty page may still include a next-page cursor. Empty items and external_ids are omitted. The cursor is omitted when the search is complete.

Rate limit: 1200 per minute.

Query Params

phone

string

A complete E.164 phone number, including the leading plus sign.

string

A complete email address, matched case-insensitively.

name

string

A partial name. Each word must match the beginning of a name word.

group_key

string

An office or group key, such as Office:123 or CallCenter:456. Matches contacts with an affinity owned by that group, not the group's employee membership.

external_id

string

Case-sensitive external contact identifier.

external_service

string

Integration provider name, required with external_id.

limit

int64

Defaults to 25

Maximum number of contacts, between 1 and 100.

cursor

string

Opaque continuation token. Keep filters unchanged to continue the same search;
omit the cursor when starting a different search. Page size may change. Expires after 15 minutes.

external_scope

string

Optional integration instance, such as a Salesforce organization ID.

Response

200A successful response