GET
/
lucca-api
/
probationary-periods
/
{id}
curl --request GET \
  --url https://{host}/lucca-api/probationary-periods/{id} \
  --header 'Api-Version: <api-version>' \
  --header 'Authorization: Bearer <token>'
{
  "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
}

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.

Path Parameters

​
id
string
required

Identifier of the probationary-period

Minimum length: 1

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.

Response

200
application/json

OK

A probationary-period resource. Embedded resources on a probationary-period(s) response. A probationary-period represents a period during which an employment's employee under scrutiny to find out if they are the right fit and have sufficient skills for the position.

Only one probationary-period may be created for a single employment.

A probationary-period start date startsOn is read-only as it must always be equal to the related employment start date startsOn.