Sign in

v1

latestOpenAPI 3.0.22026-07-26191278525.6 KB
Position

List Matched Candidates for Position

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.

get/api/v2/core/positions/{positionId}/matched-candidates

Path parameters

positionIdstring required

Position ID

Query parameters

startinteger

Specifies the offset value to start for the page

limitinteger

Specifies the number of entries to be returned for the page

filterQuerystring

filter query using predefined filter arguments documented here

leadsstring

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

validatedSkillsstring

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

excludestring

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.

keyListstring

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

Authorizationstring required

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

Response

OK