Sign in

v1

latestOpenAPI 3.0.02026-07-223589127.1 KB
People Search

Estimate people search

Pre-flight conservative credit estimate for POST /api/v1/people/search. Includes contact enrichment assumptions when includeContacts is true.

post/api/v1/people/search/estimate

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

Conservative people search preflight estimate and contact enrichment breakdown.

estimatedCreditsnumber required

Estimated credits to be consumed

likelySyncOrAsync'sync' | 'async' required

Whether the real request will return 200 or 202

expectedLatencyRangestring
withinPlanLimitsboolean required

Example response

{
  "expectedLatencyRange": "30s-5m",
  "assumptions": {
    "mode": "conservative_preflight_ceiling"
  }
}