GET
/
lucca-api
/
probationary-periods
curl --request GET \
  --url https://{host}/lucca-api/probationary-periods \
  --header 'Api-Version: <api-version>' \
  --header 'Authorization: Bearer <token>'
{
  "type": "probationary-periods",
  "url": "https://example.ilucca.net/lucca-api/probationary-periods?limit=10",
  "totalCount": 23,
  "items": [
    {
      "id": "8721",
      "type": "probationary-period",
      "url": "https://example.ilucca.net/lucca-api/probationary-periods/8721",
      "employment": {
        "id": "4561",
        "type": "employment",
        "url": "https://example.ilucca.net/lucca-api/employments/4561"
      },
      "startsOn": "2024-02-01",
      "endsOn": "2024-07-31",
      "initialEndsOn": "2024-04-31",
      "extendedEndsOn": "2024-07-31",
      "createdAt": "2024-03-24T08:21:35.001Z",
      "lastUpdatedAt": "2024-03-24T08:21:35.001Z",
      "links": null
    }
  ],
  "links": {
    "prev": null,
    "next": {
      "href": "https://example.ilucca.net/lucca-api/{resource-type}?page=!sdk87Sdh&limit=25"
    }
  }
}

Authorizations

Authorization
string
header
required

The Lucca API implements the oAuth 2 protocol with the client-credentials-flow. Refer to RFC8725.

Headers

Api-Version
enum<string>
required

Set the API version.

Available options:
2024-11-01
Examples:

"2024-11-01"

If-None-Match
string

Only execute the request if current cached version of the resource does not match the one given here.

Examples:

"W/q5sd4w2x1c1gfdg"

If-Match
string

Only execute the request if current cached version of the resource matches the one given here. Useful to avoid concurrency conflicts.

Examples:

"W/q5sd4w2x1c1gfdg"

Accept-Encoding
string

List of compression algorithms you support.

Query Parameters

include
enum<string>[]

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 be null 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.

page
string

Cursor of the page to retrieve. Read more about pagination.

limit
integer
default:25

Number of items per page. Defaults to 25. Maximum is 100. Read more about pagination.

Required range: 0 <= x <= 100
employment.employee.id
string[]

Filter out probationary-periods on the related employee.

Example:
["416"]
employment.id
string[]

Filter out probationary-periods on the employment they apply to.

Example:
["4561"]
startsOn.between
string

Filter out probationary-periods on their start date (in a range). ISO 8601 formatted date-range string.

Examples:

"2024-01-01--2024-12-31"

"..--2024-12-31"

"2024-01-01--.."

endsOn.between
string

Filter out probationary-periods on their end date (in a range). ISO 8601 formatted date-range string.

Examples:

"2024-01-01--2024-12-31"

"..--2024-12-31"

"2024-01-01--.."

initialEndsOn.between
string

Filter out probationary-periods on their initial end date (in a range). ISO 8601 formatted date-range string.

Examples:

"2024-01-01--2024-12-31"

"..--2024-12-31"

"2024-01-01--.."

extendedEndsOn.between
string

Filter out probationary-periods on their extended end date (in a range). ISO 8601 formatted date-range string.

Examples:

"2024-01-01--2024-12-31"

"..--2024-12-31"

"2024-01-01--.."

isExtended
boolean

Filter out probationary-periods on whether they were extended (true) or not (false). When omitted, both extended and non-extended probationary-periods are returned.

Example:

true

sort
enum<string>[]

Order results by instruction. Read more about sorting. Default: id.

Response

200
application/json

OK

A collection of probationary-period resources. Links on a collection. Embedded resources on a probationary-period(s) response. A collection of probationary-period objects.