Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Your organization API key, available in Organisation settings.

Body

application/json
text
string
required

Free-text brief describing the talent you are searching for

Example:

"Senior fullstack engineer with 5+ years of React and Node.js, based in Paris, fintech experience"

contractTypes
enum<string>[]

Restrict to one or more contract types: FREELANCER, FREELANCER_OPEN_TO_PERMANENT_CONTRACT (open to both freelance and permanent), or PERMANENT_CONTRACT. Buckets are independent and combine as a union (OR). Omit to include every contract type.

Available options:
FREELANCER,
FREELANCER_OPEN_TO_PERMANENT_CONTRACT,
PERMANENT_CONTRACT
Example:
excludeWithoutCv
boolean

Only return talents who have a CV/resume.

availableNow
boolean

Only return talents who are available now.

workedInStartup
boolean

Only return talents who have worked in a startup.

searchOnlyInMyTalentsATS
boolean

Restrict the search to your own talents (the ones you imported into your ATS), excluding the wider Collective network. Scope note: this covers the ATS imports of the organization account this API key is attributed to, not necessarily every recruiter in the organization.

Response

Search launched successfully

searchId
string
required

Unique identifier of the launched search, used for polling

Example:

"cm71yqftr00000ck0bpz3hpg1"

status
enum<string>
required

Status of the search right after launch

Available options:
ONGOING,
COMPLETED,
FAILED
Example:

"ONGOING"