Response envelope
Successful responses carrysuccess: true. List endpoints add pagination and data.
success: false, matching the Company Lookup API’s shape:
Pagination
integer
default:"1"
1-indexed page number. Applies to
/people and /companies.integer
default:"100"
Results per page. Maximum 1000 — a higher value returns
400 INVALID_PARAMETER rather
than being silently clamped.integer
Set to
1 to skip the count query. total and totalPages return null, which is faster on
large result sets.Walking every page
Date filtering
All dates are UTC.integer
Last N UTC days, including today. Maximum
366.string
Inclusive UTC day in
YYYY-MM-DD format.string
Inclusive UTC day in
YYYY-MM-DD format.discovered_days or the discovered_from/discovered_to pair — never both, which
returns 400. Either bound may be given on its own.
Filtering
string
default:"all"
true returns confirmed users only. false returns people we checked who are not users.
Omit for both.Rate limits
60 requests per minute per key. Every response carries:
A
429 response adds Retry-After.
A streaming request counts as one unit against this limit no matter how long it runs.
Error codes
Always branch on
error.code rather than the human-readable error.message, which may change.