Find contacts by phone number
GET /contact
Searches CRM contacts by phone number using connector-specific number formats and optional extension semantics. The server can use cached account data unless forceContactRefresh is requested. Results can include a synthetic create-new option marked isNewContact rather than an existing CRM record; clients must not treat that option as a match.
Operation ID: getContact
Authorization: BEARER or API key
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
phoneNumber |
query | string | Yes | Phone number to search, normally E.164. |
overridingFormat |
query | string | No | Comma-separated phone-number formats used by CRM-specific matching. |
isExtension |
query | boolean | No | Marks the lookup as an internal extension-number lookup. |
isForceRefreshAccountData |
query | boolean | No | Bypass and refresh cached contact search data. |
Responses
| Status | Description | Body |
|---|---|---|
200 |
Matching CRM contacts. | ContactSearchResponse |
400 |
Bad request, missing authentication, or connector error. | ErrorResponse, string |
401 |
The user session is expired or revoked. | ErrorResponse, string |