Get a holiday

GET 
/api/holidays/:id

Required permissions:

• settings.company: allows view of company holidays.

Here the dedicated support page.

Request

Path Parameters

id stringrequired

Header Parameters

Wethod-Company stringrequired

The company you want to interact with

Wethod-Version stringrequired

The API version you want to use

Responses

200

Returns the requested holiday.

application/json

Schema

Schema

id integerrequired

Possible values: >= 1

created_at date-timerequired
updated_at date-timerequired
name stringrequired

Possible values: <= 255 characters

repeating booleanrequired
exact_date date
repeating_day integer

Possible values: >= 1 and <= 31

repeating_month integer

Possible values: >= 1 and <= 12

Example (from schema)

{
  "id": 1,
  "created_at": "2024-12-20T14:44:08.169Z",
  "updated_at": "2024-12-20T14:44:08.169Z",
  "name": "string",
  "repeating": true,
  "exact_date": "2024-12-20",
  "repeating_day": 3,
  "repeating_month": 1
}

403

Forbidden

404

Not found

Loading...