List probationary-periods
List probationary-periods.
Access
Access
EstablishmentsThis API endpoint will filter out results based on accessible business-establishments.You may only access probationary-periods belonging to employees whose applicable business-establishments are accessible to you.
Authorizations
The Lucca API implements the oAuth 2 protocol with the client-credentials-flow. Refer to RFC8725.
- Token URL
- https://accounts.world.luccasoftware.com/connect/token
Headers
Set the API version.
2024-11-01 "2024-11-01"10"2024-11-01"
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
Cursor of the page to retrieve: the page value of links.next.href or links.prev.href in a previous response.
Cursors are opaque: don't build or modify them. An invalid cursor gets a 400 Bad Request.
Read more about pagination.
Number of items per page. Defaults to 25. Maximum is 1,000. Read more about pagination.
0 <= x <= 1000Filter out probationary-periods on the related employee.
1Filter out probationary-periods on the employment they apply to.
1Filter out probationary-periods on their start date (in a range). ISO 8601 formatted date-range string. ISO 8601 formatted date-range string. Examples:
2024-01-01--2024-12-31: from Jan. 1st 2024 until Dec. 31st 2024 (included)...--2024-12-31: until Dec. 31st 2024.2024-01-01--..: from Jan. 1st 2024.
^(?:\d{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\d|3[01])|\.\.)--(?:\d{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\d|3[01])|\.\.)$"2024-01-01--2024-12-31"
"..--2024-12-31"
"2024-01-01--.."
Filter out probationary-periods on their end date (in a range). ISO 8601 formatted date-range string. ISO 8601 formatted date-range string. Examples:
2024-01-01--2024-12-31: from Jan. 1st 2024 until Dec. 31st 2024 (included)...--2024-12-31: until Dec. 31st 2024.2024-01-01--..: from Jan. 1st 2024.
^(?:\d{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\d|3[01])|\.\.)--(?:\d{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\d|3[01])|\.\.)$"2024-01-01--2024-12-31"
"..--2024-12-31"
"2024-01-01--.."
Filter out probationary-periods on their initial end date (in a range). ISO 8601 formatted date-range string. ISO 8601 formatted date-range string. Examples:
2024-01-01--2024-12-31: from Jan. 1st 2024 until Dec. 31st 2024 (included)...--2024-12-31: until Dec. 31st 2024.2024-01-01--..: from Jan. 1st 2024.
^(?:\d{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\d|3[01])|\.\.)--(?:\d{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\d|3[01])|\.\.)$"2024-01-01--2024-12-31"
"..--2024-12-31"
"2024-01-01--.."
Filter out probationary-periods on their extended end date (in a range). ISO 8601 formatted date-range string. ISO 8601 formatted date-range string. Examples:
2024-01-01--2024-12-31: from Jan. 1st 2024 until Dec. 31st 2024 (included)...--2024-12-31: until Dec. 31st 2024.2024-01-01--..: from Jan. 1st 2024.
^(?:\d{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\d|3[01])|\.\.)--(?:\d{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\d|3[01])|\.\.)$"2024-01-01--2024-12-31"
"..--2024-12-31"
"2024-01-01--.."
Filter out probationary-periods on whether they were extended (true) or not (false). When omitted, both extended and non-extended probationary-periods are returned.
true
Order results by instruction. Read more about sorting. Default: id.
id, -id, startsOn, -startsOn, endsOn, -endsOn 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 benullwhen 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.
embedded, links, totalCount Response
OK
A collection of probationary-period resources.
"probationary-periods"Total number of probationary-period resources across all pages that satisfy query parameters.
x >= 01000Links to related resources
No embedded resources on a probationary-period(s) response. Expect an empty object if embedded are requested.