Positions

GET /positions

Group: People Management › Positions · Operation ID: positions

Returns a list of positions. GET positions/:id returns a richer record, including the job profile and region references.

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 — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
positionNumber — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
name — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
overtimeStatus — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
status — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
timelineStatus — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
lastModifiedDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
Orderable: id, positionNumber, name, hiringManagerName, desiredHeadcount, employeeCount, status, timelineStatus, lastModifiedDate
Selectable: id, positionNumber, name, description, desiredHeadcount, employeeCount, expectedSalary, hiringManagerName, overtimeStatus, status, timelineStatus, lastModifiedDate

200 Success

Under data, an array of positionsRow:

Field	Type	Required	Description
`id`	string	no	The unique identifier for the position.
`positionNumber`	string or null	no	The system-generated position number, for example 'POS-100010'. Absent while none has been assigned.
`name`	string	no	The display name of the position.
`description`	string or null	no	A free-form description of the position's responsibilities. Absent when none is set.
`desiredHeadcount`	number or null	no	The target number of people to fill this position.
`employeeCount`	number or null	no	The number of employees currently in this position.
`expectedSalary`	number or null	no	The expected annual salary for this position, in the entity's currency.
`hiringManagerName`	string or null	no	The full name of the hiring manager. Absent when none is assigned.
`overtimeStatus`	string or null	no	The overtime eligibility of the position. Possible values: 'EXEMPT', 'NON_EXEMPT'.
`status`	string or null	no	The fill status of the position. Possible values: 'unfilled', 'partiallyFilled', 'filled', 'overfilled', 'inactive'.
`timelineStatus`	string or null	no	The timeline status of the position. Possible values: 'planned', 'inactive', 'active', 'canceled'.
`lastModifiedDate`	string (date-time) or null	no	The date and time the position record last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.