Enrich profiles in a batch

Enrich between 1 and 100 profiles in one request. Each item must provide exactly one docid, uuid, or email; enrichment options apply to the entire batch. Results preserve input order, and reference_id can be used to correlate results with client records.

A valid batch returns HTTP 200 even when individual profiles are not found. Inspect each result's http, profile, and error fields. Request validation and infrastructure errors remain top-level HTTP errors.

UUID inputs use masked profile enrichment, matching GET /v1/profile?uuid=.... For other identifiers, pricing is additive per successful item.

Costs are additive per successful item: with_profile costs 1 credit, high_freshness costs 2 credits, reveal_emails costs 6 credits and reveal_phones costs 6 credits when the corresponding contact data is found, github_enrich costs 8 credits when applied, and resolving an email costs 6 credits. UUID inputs instead cost 25 credits each for masked enrichment.

Rate limit: 180 batch requests per user per 60 seconds. A batch counts as one request regardless of its number of items. Batches containing email identifiers also count as one request against the account's daily email-lookup limit.

Body Params
profiles
array of objects
required
length between 1 and 100

Profiles to enrich. Results preserve this input order. Duplicate identifiers are rejected.

profiles*
string
length between 1 and 512

Optional client-defined value copied to the corresponding result.

string
required
length between 1 and 512

LinkedIn profile slug, which is the part after https://www.linkedin.com/in/.

uuid

UUID from a masked search result. UUID inputs use masked profile enrichment.

string
length ≤ 512

Email address to resolve to a LinkedIn profile. This lookup is separate from reveal_emails.

boolean
Defaults to false

Enable realtime profile updates for every non-UUID item. Cost: 2 credits per successfully returned profile

boolean
Defaults to false

Include email addresses when available. Cost: 6 credits per profile for which email data is found. Deprecated name: show_emails

boolean
Defaults to false

Include phone numbers when available. Cost: 6 credits per profile for which phone data is found. Deprecated name: show_phone_numbers

boolean
Defaults to false

Include full stored profile data. Cost: 1 credit per successfully returned profile

boolean

Add available GitHub developer fields. Cost: 8 credits per profile enriched from GitHub

boolean
Defaults to false

Return the compact profile representation.

omit_fields
array of strings

Profile fields to remove from every successful result.

omit_fields
boolean
deprecated

Deprecated alias for reveal_emails.

boolean
deprecated

Deprecated alias for reveal_phones.

Responses

400

Invalid JSON, batch size, identifier, duplicate, or option.

401

Invalid API key

402

Insufficient credits

429

Rate limit exceeded. JSON body contains the triggered window, current value, and limit.

500

Batch enrichment failed

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json