Skip to main content
GET
JavaScript

Authorizations

Authorization
string
header
required

Authentication header containing API key (find it in dashboard). The format is "Bearer YOUR_API_KEY"

Path Parameters

phone_number
string
required

Phone number of the contact, E.164 preferred. Other formats are normalized before the lookup; a number that cannot be parsed is rejected with 400.

Response

Contact found.

contact_id
string
required

Unique identifier for the contact.

org_id
string
required

Organization this contact belongs to.

phone_number
string
required

Phone number of the contact.

created_timestamp
number
required

Epoch milliseconds when the contact was created.

first_name
string

First name of the contact.

last_name
string

Last name of the contact.

do_not_call
boolean

Whether this contact should not be called.

external_id
string

CRM record ID from the external provider.

custom_fields
object

Custom fields defined in CRM config.

conversation_count
number

Number of conversations (calls and chats) associated with this contact.

last_conversation_timestamp
number

Epoch milliseconds of the most recent conversation with this contact.

user_modified_timestamp
number

Epoch milliseconds when the contact was last modified.