Skip to main content
The Get Contact endpoint retrieves a single contact record by a flexible identifier. You can look up any contact using their internal ChatbotX ID, their email address, or their phone number — all with the same endpoint. The response includes the full contact object with profile fields, tags, custom fields, notes, inbox connections, and the most recent conversation.
GET /api/v1/contacts/{identifier}

Path Parameters

string
required
A contact lookup string using one of the three supported prefix formats. Minimum length: 1 character.

Code Examples

Response Fields

string
required
Unique contact ID.
string (date-time)
required
Timestamp when the contact was created.
string (date-time)
required
Timestamp of the last update.
string | null
required
URL of the contact’s profile image.
string | null
required
Contact’s phone number.
string | null
required
Contact’s email address.
boolean
required
Whether the email has been verified.
boolean
required
Whether the contact opted in to email communications.
string | null
required
Contact’s first name.
string | null
required
Contact’s last name.
string | null
required
Computed full name.
string | null
required
One of male, female, unknown.
string (date-time) | null
required
When the contact last read a message.
string | null
required
External reference identifier.
string | null
required
Contact’s country.
string | null
required
Contact’s state or region.
string | null
required
Contact’s city.
string | null
required
Contact’s locale string.
string | null
required
Contact’s timezone.
string (date-time) | null
required
When the contact subscribed.
string (date-time) | null
required
When the contact subscribed to broadcasts.
string (date-time) | null
required
When blocked, or null if not blocked.
string
required
ID of the owning Workspace.
array
required
Custom field values for this contact.
array
required
Tags applied to this contact.
array
required
Notes attached to this contact.
array
required
Active inbox connections for this contact.
object | null
required
Most recent conversation object, or null.

Example Response