v1

latestOpenAPI 3.0.22026-07-26191278525.6 KB
Position

List Positions

Search positions using query parameters and get the complete position objects

get/api/v2/core/positions

Query parameters

startinteger

Specifies the offset value to start for the page

limitinteger

Specifies the number of entries to be returned for the page

atsJobIdstring

unique identifier in the ATS system

filterQuerystring

Filter query using predefined filter arguments documented here

querystring

any wildcard text to search in position

includeArchivedboolean

show archived positions

positionIdsstring

Comma-separated list of position ids to fetch. Can be combined with query/filterQuery to narrow within the set.

includestring

Include additional fields in the response. Possible values are atsData, calibrationData

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