List Matched Candidates for Position

get

https://apiv2.{domain}.ai/api/v2/core/positions/{positionId}/matched-candidates

Returns all the matching candidates for a position based on the filter query params provided in the API request. NOTE: The output may differ from UI pages as those pages may use additional configs, that are configured separately. Top 1000 Leads can be requested using the leads query parameter.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

positionId

string

required

Position ID

Query Params

start

integer

Specifies the offset value to start for the page

limit

integer

Specifies the number of entries to be returned for the page

filterQuery

string

filter query using predefined filter arguments documented here

leads

string

Request leads profiles for this position, as shown on the pipeline page

validatedSkills

string

Request validated and missing skills, as shown on the profile page matching insights

exclude

string

Exclude specific fields in the response. Possible values are the names of the top level fields present in corresponding API schema. To check API schema, expand the response section below.

keyList

string

Allows selective control over the fields returned in the API response. If the keyList is empty, all fields will be returned. Possible values are the names of the top level fields present in corresponding API schema. To check API schema, expand the response section below.

Headers

Authorization

string

required

The secret key to access the api. It starts with the bearer token

Response

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK