Create a search job

Queues the job and returns 202. Poll GET /searches/{id}, stream GET /searches/{id}/events, or wait for the search.completed webhook, then page GET /searches/{id}/results.

post/searches

Request

  • Base URL: https://api.instalent.io/api/v1
  • URL: https://api.instalent.io/api/v1/searches
  • Auth: HTTP bearer and API key in header X-Customer-Key

Headers

Idempotency-Keystring

8 to 128 characters. A retry with the same key returns the original job.

Request body

mode'candidate' | 'client'
openToWorkboolean

Has no effect since 2026-10-06 (still accepted): open to work is not a search option. Every result carries openToWork instead, read from the person's profile: true when they say they are looking, or hold no job and the last one ended within two years; null otherwise. Never false: nobody can tell that a person is not looking.

maxResultsinteger

An upper bound, not a target. Candidate searches return only people who closely match the criteria, typically about 85 to 115 for a specific role and city, so a higher value rarely returns more.

Response

Replayed: this Idempotency-Key already created a job, so the original is returned.

idstring required
kind'search' | 'enrichment' | 'analysis' required
status'queued' | 'running' | 'succeeded' | 'failed' | 'cancelled' required
inputobject required
summaryobject nullable required
createdAtstring required
startedAtstring nullable required
finishedAtstring nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.