Sign in

v1

latestOpenAPI 3.0.22026-07-26191278525.6 KB
Profile Application

List Profile Applications

Search profile applications using specific filter parameters and get all attributes of profile applications

get/api/v2/core/profile-applications

Query parameters

startinteger

Specifies the offset value to start for the page

limitinteger

Specifies the number of entries to be returned for the page

queryLimitstring

Limit on the total number of search results, defaults to 100

applicationIdstring

Filter on application id

profileIdstring

Filter on profile id of the candidate. Accepts the numeric or encoded profile id.

positionIdstring

Filter on position id associated with the application

atsJobIdstring

Filter on ats job id

applicationStatusstring

Filter on status of the application

stagestring

Filter on application stage

entityIdsstring

Comma-separated list of application ids to fetch. Can be combined with the other filters to narrow within the set.

includestring

Include additional fields in the response. Possible values are customInfo

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