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. An exact stored match is returned first, including contacts with custom SIP caller IDs. If no exact match exists, other formats are normalized for a fallback lookup.

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.

contact_memory
string

Running brief shared across this contact's phone calls and SMS chats. Omitted when unset.

Maximum string length: 2000
external_id
string

CRM record ID from the external provider.

contact_tags
object[]

Assigned tag IDs and labels from the organization's CRM config. IDs absent from the config are omitted.

Maximum array length: 50
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.