Security: OAuth 2.0
Security: OAuth 2.0
job-positions.readonly
job-positions.readwrite
Authorizations
The Lucca API implements the oAuth 2 protocol with the client-credentials-flow. Refer to RFC8725.
Headers
Only execute the request if current cached version of the resource does not match the one given here.
"W/q5sd4w2x1c1gfdg"
Only execute the request if current cached version of the resource matches the one given here. Useful to avoid concurrency conflicts.
"W/q5sd4w2x1c1gfdg"
List of compression algorithms you support.
Query Parameters
Include metadata:
embedded
: the partial or complete representations of related resources (e.g. the employee the resource belongs to).links
: links to related resources or actions (e.g. approving a leave-request). May benull
when you do not have access to the resource (or action).totalCount
: only applicable on collections (i.e. lists of resources), gives the total number of items across all pages.
Read more about expanding responses.
Filter out job-positions on their IDs. Comma-separated list of strings.
100
["345", "985"]
Filter out job-positions on their remoteId. Comma-separated list of strings.
100
["JOB000423"]
Filter out job-positions on their employment IDs. Comma-separated list of strings.
100
["90", "74"]
Filter out job-positions on their business-establishment IDs. Comma-separated list of strings.
100
["1", "3"]
Filter out employments on their status.
active
, upcoming
, deactivated
"active"
Filter out job-positions on their startsOn date (strict equality).
Filter out job-positions on their startsOn date (range). ISO 8601 formatted date-range string.
"2024-01-01--2024-12-31"
"..--2024-12-31"
"2024-01-01--.."
Filter out job-positions on their endsOn date (strict equality).
Filter out job-positions on their endsOn date (range). ISO 8601 formatted date-range string.
"2024-01-01--2024-12-31"
"..--2024-12-31"
"2024-01-01--.."
Filter out job-positions on their job-qualification IDs. Comma-separated list of strings.
100
["45", "56"]
Filter out job-positions on their occupation-category IDs. Comma-separated list of strings.
100
["17", "18"]
Filter out job-positions on their manager IDs. Comma-separated list of strings.
100
["123", "456"]
Filter out job-positions on their department IDs. Comma-separated list of strings.
100
["43"]
Only return job-positions that changed one of the given attributes.
100
["jobTitle"]
Order results by instruction. Read more about sorting. Default: id
.
100
["id"]
Cursor of the page to retrieve. Read more about pagination.
Number of items per page. Defaults to 25. Maximum is 100. Read more about pagination.
0 <= x <= 100
Response
OK
A collection of job-position objects. Embedded resources on a job-position(s) response. Links on a collection. A collection of job-position resources.
"job-positions"
Paginated list of job-position resources.
100
Total number of job-position resources across all pages that satisfy query parameters.
x >= 0
Links to related resources