REretellai

GET /get-contact-by-phone/{phone_number}

Changed on

Retrieve a contact by phone number. At most one contact exists per phone number in an organization.

Request

  • Base URL
    https://api.retellai.com
  • Auth
    HTTP bearer

Path parameters

phone_numberstring 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_idstring required

Unique identifier for the contact.

org_idstring required

Organization this contact belongs to.

phone_numberstring required

Phone number of the contact.

first_namestring

First name of the contact.

last_namestring

Last name of the contact.

do_not_callboolean

Whether this contact should not be called.

contact_memorystring

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

external_idstring

CRM record ID from the external provider.

custom_fieldsobject

Custom fields defined in CRM config.

conversation_countnumber

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

last_conversation_timestampnumber

Epoch milliseconds of the most recent conversation with this contact.

created_timestampnumber required

Epoch milliseconds when the contact was created.

user_modified_timestampnumber

Epoch milliseconds when the contact was last modified.

Changes