Sign in

v1

latestOpenAPI 3.0.02026-07-223589127.1 KB
People Search

Search people

Async people discovery. Returns operationId; poll GET /api/operations/:id.

post/api/v1/people/search

Headers

Idempotency-Keystring

Optional. Reusing the same key for the same organization returns the existing queued operation.

Request body

querystring required
limitnumber
includeSignalsboolean
includeContactsboolean
contactFieldsstring[]

Contact fields to enrich when includeContacts is true. Omit to preserve legacy includeContacts=true behavior, which requests both email and phone.

maxCreditsnumber

Maximum credits the people search operation may charge. When omitted, normal account limits apply.

confirmboolean

Example request

{
  "query": "VP Engineering at hiring B2B SaaS companies in SF",
  "contactFields": [
    "email"
  ],
  "maxCredits": 2500
}

Response

People search accepted. Poll the returned URL for results.

idstring required
operationIdstring required
status'queued' required
pollUrlstring required
metaobject required