Skip to main content
POST
cURL

Authorizations

x-api-key
string
header
required

Provide your API key in the x-api-key header.

Body

application/json

Provide email, linkedin_url, or a name (first_name/last_name) together with company_domain or company_name. A name is never searched unconstrained.

email
string

Email to look up in the connected CRM(s).

linkedin_url
string

LinkedIn profile URL to look up. HubSpot/Salesforce only.

first_name
string

Used with last_name + a company when no email/LinkedIn is available. Matches are fuzzier and reported with a lower confidence.

last_name
string
company_domain
string

Constrains a name search to that company. Preferred over company_name (more precise).

company_name
string

Fallback company constraint when no domain is known. Yields confidence: low.

crm
enum<string>

Restrict the search to a single CRM instead of all connected ones.

Available options:
hubspot,
salesforce,
pipedrive,
sellsy

Response

CRM matches with owner

matches
object[]
searched_crms
string[]

The connected CRMs actually queried.

default_crm
string | null

The CRM a crm-less sync would resolve to (same rules as POST /trigger/crm-sync). Null when ambiguous: ask the user which CRM to act on.

errors
object[]

Per-CRM lookup failures. Present only when a provider errored. IMPORTANT: an empty matches alongside errors is NOT a confirmed "no match" — do not treat it as "contact is new".