Skip to main content
GET
Available while the search is still running. Reading results is free. Results are only ever added, never changed or removed. Store next_cursor and pass it as after to read only the people found since your last call. next_cursor is always returned, even on an empty page. has_more: false means there are no more stored results right now. It does not mean the search has finished: check search_status.

Path parameters

string
required
The search’s id, returned when it was started.

Query parameters

integer
default:"25"
Page size.Range: 1 to 100.
string
The next_cursor from the previous page. Omit it on the first call.

Response

200 A page of people.
string
required
Always list.
object[]
required
People, in the order they were found.
boolean
required
Whether more stored results are available now. false does not mean the search has finished.
string
required
Pass as after to read the results after this page. Always returned. Store it and send it back unchanged; do not parse it.
string
required
The search’s status when this page was read.Options: queued, running, completed, failed, cancelled.

Errors

Every error uses the same shape. See Errors.