Skip to navigation

Get a contact by phone number

Returns the contact that has the phone number, with its 10 newest notes. The API adds the + if it is not there. A + in a query string reads as a space, so encode it as %2B.

Authentication

api_access_tokenstring

An API key that an administrator creates in Settings > Developer. The personal access token of a user does not work. A key reaches every inbox, conversation, and contact in the account that created it, and nothing in other accounts.

Path parameters

account_idintegerRequired

The id of your account. It is the number after /accounts/ in the dashboard URL.

Query parameters

phone_numberstringRequired
The phone number of the contact in E.164 format.

Response

The contact.
payloadobjectOptional

A contact, without contact_inboxes, with its 10 newest notes.

Errors

401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error