v1

latestOpenAPI 3.0.22026-07-26191278525.6 KB
Profile

List Profiles

Search profiles using query parameters and get the complete profile objects

get/api/v2/core/profiles

Query parameters

startinteger

Specifies the offset value to start for the page

limitinteger

Specifies the number of entries to be returned for the page

atsCandidateIdstring

Unique identifier in the ATS system

profileIdsstring

Comma separated list of profile ids (numeric or encoded)

filterQuerystring

Filter query using predefined filter arguments documented here

querystring

Any wildcard text to search in position

includestring

Include additional fields in the response. Possible values are resume, applications, tags, notes, attachmentsInfo, inferredSkills, careerSiteQuestions, deletedAt, demandExperiences, jtnSubmissions, lastContact

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