Skip to main content
GET
/
lucca-api
/
probationary-periods
/
{id}
Retrieve a probationary-period
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-30",
  "extendedEndsOn": "2024-07-31",
  "createdAt": "2024-03-24T08:21:35.001Z",
  "lastUpdatedAt": "2024-03-24T08:21:35.001Z",
  "links": {},
  "embedded": {}
}
This API endpoint is in beta and may be subject to changes, including breaking changes (similarly to the legacy API endpoints), without prior notice. Read more about versioning.
OAuth 2.0 scopes
 probationary-periods.readonly
or
 probationary-periods.readwrite
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

​
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
Allowed value: "2024-11-01"
Maximum string length: 10
Example:

"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.

Example:

"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.

Example:

"W/q5sd4w2x1c1gfdg"

​
Accept-Encoding
string

List of compression algorithms you support.

Path Parameters

​
id
string
required

Identifier of the probationary-period

Minimum string 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.

Available options:
embedded,
links,
totalCount

Response

OK

A probationary-period resource.

​
id
string
Minimum string length: 1
​
type
string
Allowed value: "probationary-period"
​
url
string<uri>
​
employment
employment-reference · object

The employment this probationary-period applies to. Cannot be modified once the probationary-period is created.

​
startsOn
string<date>

Read-only. Equal to the related employment start date.

Pattern: ^\d{4}-\d{2}-\d{2}$
​
endsOn
string<date>

Read-only. End date of the probationary-period, equal to extendedEndsOn if not null, and initialEndsOn otherwise.

Pattern: ^\d{4}-\d{2}-\d{2}$
​
initialEndsOn
string<date>

Initial end date of the probationary-period. Required upon creation.

Pattern: ^\d{4}-\d{2}-\d{2}$
​
extendedEndsOn
null | string<date>

End date of the probationary-period in case it was extended.

Pattern: ^\d{4}-\d{2}-\d{2}$
​
createdAt
string<date-time-offset>

Read-only. UTC timestamp of the moment this object was created.

Example:

"2023-01-23T12:45:23.1234Z"

​
lastUpdatedAt
string<date-time>

Read-only. UTC timestamp of the moment this object was last updated. Set upon creation, update or deletion of the object.

Example:

"2023-01-23T12:45:23.1234Z"

​
links
object
​
embedded
object

No embedded resources on a probationary-period(s) response. Expect an empty object if embedded are requested.