Skip to main content
GET
Lookup Contact Context by Phone
Retrieves full CRM context for a customer from their incoming chat phone number, including matched contact profiles, active leads, and recent follow-up reminders.

Phone normalization

The phone query parameter accepts phone numbers with or without a leading +, national punctuation, or country codes. The CRM automatically parses and normalizes the number to match against stored contact profiles.

Query parameters

  • phone (string, required): Customer phone number to resolve (e.g. +15551234567 or 919876543210).

Returned context

  • matched (boolean): Indicates whether a matching contact was identified.
  • contact (object): Matched contact record, including tags and custom fields.
  • leads (array): Active or closed deals associated with the contact.
  • recent_followups (array): Scheduled follow-ups or recent action items.

Required permissions

Requires an API key with the crm:read scope.

Authorizations

x-api-key
string
header
required

Workspace API key header. The key implicitly determines your workspace isolation. Scopes: crm:read for GET/HEAD/OPTIONS, crm:write for POST/PATCH/PUT/DELETE.

Query Parameters

phone
string
required

Phone number with or without leading '+', country code, or national formatting

Example:

"+15551234567"

Response

CRM context resolved successfully

Standard envelope returned by all GET (read) endpoints

status
string
required
Example:

"success"

code
integer
required
Example:

200

message
string
required
Example:

"Integrations public retrieved successfully"

data
object
required

The returned entity, collection, or payload

timestamp
string<date-time>
required
Example:

"2026-10-26T10:00:00.000Z"