Skip to main content
GET
List work-contracts
This legacy endpoint has its equivalent in the Lucca API (currently in beta): GET /lucca-api/employments.Career data (department, manager, job title) is now tracked separately through the job-position resource.

Headers

Authorization
string
required

API key. Value must be formatted like so: lucca application={api_key}.

Query Parameters

page
integer

Index of the page to retrieve. Starts at 1.

Required range: x >= 1
limit
integer

Page size (i.e. number of items per page).

Required range: 0 <= x <= 1000
fields.root
string

Retrieve the total number of items across all pages.

Allowed value: "count"
ownerId
integer[]

Only return work-contracts whose employees' ID match one of the given.

Required range: x >= 1
isApplicable
boolean

Only return work-contracts that are considered applicable (true) or not (false). When omitted, both are returned.

isArchived
boolean

Only return archived (true) work-contracts or active (false) ones.

typeId
integer[]

Only return work-contracts which reference one of the given work-contract types IDs.

Required range: x >= 1
establishmentId
integer[]

Only return work-contracts which belong to one of the given establishments IDs.

Required range: x >= 1

Response

OK

items
work-contract · object[]
count
integer
Required range: x >= 0