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
enrichment_type
enum<string>[]
required

Types of enrichment to perform.

Minimum array length: 1
Available options:
email,
phone,
profile
contacts
object[]
required

Contacts to enrich. Maximum 10 contacts per request.

Required array length: 1 - 10 elements
custom
object
detect_job_change
boolean

When true, each contact in the response will include a jobChangeDetected field indicating whether the contact has changed company since the input data was provided.

Only effective when enrichment_type includes "profile".

force_refresh
boolean

Opt out of the 24h enrichment cache for this call. When a contact was already enriched for your account within the last 24 hours, the cached result is returned and no credits are consumed; pass true to force a fresh enrichment instead (credits are consumed and the cache entry is refreshed).

sync_to_crm
boolean

Push the enriched contact into your connected CRM. Disabled by default: without it, this endpoint only enriches and never writes to your CRM.

When true, the write-back uses the integration mapping configured for the Chrome extension (contact unicity criteria, create fields, company create fields). It can therefore create contacts and companies that did not exist, and the created records are owned by the CRM user linked to the API key holder.

To push records to your CRM with a dedicated mapping and a run status, use POST /trigger/crm-sync instead.

source
enum<string>

Reserved for LoneScale-hosted callers (the Slack bot). Meters the enrichment on the API key holder's per-user Chrome quota instead of the organization balance, and answers 403 when that quota is reached. Requires source_signature; leave both unset for integrations.

Available options:
slack
source_signature
string

Signature proving source comes from LoneScale. Set by the LoneScale Slack agent; integrations never send it.

Response

Contacts enriched successfully

contacts
object[]

List of enriched contacts.