OpenAPI 3.0.3AGPL-3.0 license2026-08-2011401.7 MB

9217eedacbb8

public

Publicly re-fetch a list of contacts

Does not return email or phone. Do not call this when the user asked for email or phone. Re-fetch public profile data for a specific list of your own contacts (contact ids from a list already shown, not raw profile URLs): the way to visit many people at once instead of one visit_profile per person. Public and cookieless: no connected account is touched. When the target is ambiguous and the pool is large, ask which people rather than defaulting to everyone. qualify:true grades against the ICP and spends AI credits, only when the user asked to be graded; plain visit or enrich is data only.

post/public/enrich

Request body

contactIdsstring[] required

Which of your own contacts to (re)fetch. An explicit list — not a filter — so nothing is enriched by accident.

campaignIdstring

Link newly-touched contacts to this campaign (slug or id).

qualifyboolean

Also grade each enriched contact against the campaign's bound ICP (requires campaignId — the ICP is campaign-scoped). Off by default: enrichment is the common case, grading is something to ask for explicitly, since it spends AI credits.

Response

Batch result (or a stillRunning partial for a batch that outlived this call's wait)

source'public' required

batchIdstring required

Pass this to GET the same endpoint if stillRunning is set, to check on it later.

totalinteger required

How many contacts were actually queued (already-fresh and unreachable ones are skipped up front).

visitedinteger required

Successfully re-fetched.

failedinteger required

Could not be reached (deleted, restricted, or no public page).

skippedinteger required

Deferred, not attempted this call.

qualifiedinteger

Graded against the ICP, when qualify was requested.

status'processing' | 'completed' | 'partial' | 'failed' required

failureReasonstring

stillRunningboolean

The batch outlived this call's wait and is still working — everything above is real and already landed, not a failure. Check back with GET ?batchId=.