Work-Contracts
List work-contracts
Retrieve a paginated collection of work-contracts.
get/directory/api/4.0/work-contracts
Query parameters
pageinteger
Page number
limitinteger
Page size
fields.root'count'
Retrieve the total number of items across all pages.
ownerIdinteger[]
Only return work-contracts whose employees' ID match one of the given.
isApplicableboolean
Only return work-contracts that are considered applicable (true) or not (false). When omitted, both are returned.
isArchivedboolean
Only return archived (true) work-contracts or active (false) ones.
typeIdinteger[]
Only return work-contracts which reference one of the given work-contract types IDs.
establishmentIdinteger[]
Only return work-contracts which belong to one of the given establishments IDs.
Response
OK
Example response
{
"items": [
{
"id": 514,
"ownerId": 416,
"startsOn": "2021-01-01",
"endsOn": null,
"isApplicable": true,
"establishmentId": 13,
"spcId": 1,
"typeId": 1,
"hiringTypeId": 3,
"terminationReasonId": null,
"trialPeriodDays": 120,
"renewedTrialPeriodDays": null,
"trialPeriodEndDate": "2021-05-01",
"trialPeriodEndDate2": null,
"authorId": 45,
"lastModifierId": 45,
"createdAt": "2021-11-08T17:48:18.12",
"lastModifiedAt": "2024-01-10T12:27:02.22"
}
]
}