Get Position

GET /positions/{id}

Group: People Management › Positions · Operation ID: getPosition

Returns the position with the given identifier. Use the position's id, not its positionNumber.

Open in the interactive reference

Parameters

Name In Type Required Description
Api-Version header "v1" yes The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version v1.
id path string yes The unique identifier for the position to return.

Response

200 Success

Under data (getPositionOutput):

Field Type Required Description
id string yes The unique identifier for the position.
positionNumber string no The system-generated position number, for example 'POS-100010'. Absent while none has been assigned.
name string yes The display name of the position.
description string no A free-form description of the position's responsibilities. Absent when none is set.
desiredHeadcount number no The target number of people to fill this position.
employeeCount number no The number of employees currently in this position.
expectedSalary number no The expected annual salary for this position, in the entity's currency.
overtimeStatus string no The overtime eligibility of the position. Possible values: 'EXEMPT', 'NON_EXEMPT'.
status string no The fill status of the position. Possible values: 'unfilled', 'partiallyFilled', 'filled', 'overfilled', 'inactive'.
timelineStatus string no The timeline status of the position. Possible values: 'planned', 'inactive', 'active', 'canceled'.
startDate string no The date the position becomes active. Format YYYY-MM-DD.
endDate string no The date the position becomes inactive. Format YYYY-MM-DD. Absent for an open-ended position.
hiringManagerId string no The identifier of the hiring manager. Absent when none is assigned. See id on GET people/:id.
hiringManagerName string no The full name of the hiring manager. Absent when none is assigned.
jobProfileId string no The identifier of the associated job profile. Absent when none is assigned. There is no endpoint for it.
jobProfileName string no The name of the associated job profile. Absent when none is assigned.
regionId string no The identifier of the region the position is based in. Absent when none is assigned. There is no endpoint for it.
regionName string no The name of the region the position is based in. Absent when none is assigned.
lastModifiedDate string (date-time) yes The date and time the position record last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.

Errors

Code Status
NOT_FOUND 400

Statuses