API Reference

Candidate Search

post
https://api.adept-id.com/candidate-feeds/v2/search

Searches and recommends candidates for a job from a candidate feed.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer
Defaults to 0

Offset for pagination (default 0, i.e., start of list).

integer
Defaults to 25

Maximum number of candidates to return (default 25).

integer
Defaults to 5

Number of skills to include in the match report (default 5).

string
required

Job title to filter candidates by.

string
required

The job_description field contains the text for the entire job posting. This is the body of text originally submitted for the job, before it was parsed. This information is used to build a more robust understanding of the job requirements not captured by other search inputs.

string | null

Employer name to filter candidates by.

number
Defaults to 0

Minimum match score threshold (0-1). Default is 0.

string | null

Earliest profile creation date (ISO 8601).

string | null

Latest profile creation date (ISO 8601).

string | null

Earliest profile update timestamp.

string | null

Latest profile update timestamp.

location

Location criteria for the candidate (e.g. city, country, radius).

string | null
enum

Whether or not to include remote candidates among local candidates in search results.

Allowed:
certifications
array of objects

Certifications to match candidates against.

certifications
skills
array of strings

Skills to filter candidates by.

skills
languages
array of strings

Languages the candidate must speak.

languages
education
array of objects

Education degree or field filters.

education
years_of_experience

Range for total years of candidate experience.

custom_filters

Custom search filters defined by customer.

string | null

Session ID for grouping multiple requests into a logical user session.

string | null

User making the query, for audit/tracking purposes.

string
required

The ID of the candidate feed to search.

Responses

Updated 4 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago