Inbox Lookup
Lookup by phone
Looks up comprehensive CRM context (matched contact record, active leads, and recent follow-ups) for an incoming chat message using phone number normalization and country code resolution. Requires crm:read scope.
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
Thephone 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.+15551234567or919876543210).
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 thecrm:read scope.Authorizations
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 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
Lookup Contact Context by Phone
