Get People Search Status
people-search-statusCheck a People Search task's status, progress, and cost, and page through the people found so far. Use the returned cursor to fetch only people added since the last call.
Instructions
Status, progress, and cost of one People Search task, plus a page of the people found so far: name, handle, url, platform, audience, location, fit score, why they matched, contacts, and links. Free. People arrive while the search runs: pass the returned next_cursor as cursor on the next call to get only the people found since then. When done is true and has_more is false you have everyone the search found. An ended task has completion_reason (why it stopped), coverage_limited: true when a budget stopped it before count (more people may match), and warnings such as partial_enrichment (some profiles could not be read, so those people were scored on the search hit; they show enrichment: failed). Each person has fully_verified (every criterion confirmed by their own profile or posts) and unverified_criteria (criteria that are unknown or not met, or a disqualifier that applies). These are information only: the person still qualified.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | People per page (1-100, default 25). | |
| cursor | No | next_cursor from the previous people-search-status call. Omit to start from the first person. | |
| task_id | Yes | task_id returned by people-search, example: '3f1c2b9e-8d4a-4c1e-9b7a-2e5f6a7b8c9d' | |
| include_people | No | Set false to read only the status, progress, and cost. |