Skip to content

Get the time off settings

GET
/leave-policy
curl --request GET \
--url https://example.com/leave-policy \
--cookie bottle.session_token=<bottle.session_token>

How much holiday a year, when the holiday and sickness years turn over, and whether requests are booked straight away or wait for a yes. A driver can agree different terms; those are on the driver.

Settings

Media typeapplication/json
object
holidayAllowance
required
number
<= 366
holidayUnit
required
string
Allowed values: days weeks
holidayYearStart
required
string
/^(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$/
sicknessYearStart
required
string
/^(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$/
holidayApproval
required
string
Allowed values: auto manual
sicknessApproval
required
string
Allowed values: auto manual
carryOverMax
required
number
<= 366
sicknessAllowance
required
number | null
<= 366
updatedAt
required
string format: date-time
Example
{
"holidayUnit": "days",
"holidayYearStart": "04-01",
"sicknessYearStart": "04-01",
"holidayApproval": "auto",
"sicknessApproval": "auto"
}

Not signed in

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
"error": "not_found",
"message": "Customer not found"
}

Not a member, or without the permission this needs

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
"error": "not_found",
"message": "Customer not found"
}

Validation failed

Media typeapplication/json
object
error
required
string
Allowed values: validation
message
required
string
issues
required
Array<object>
object
path
required
string
message
required
string
Example
{
"error": "validation",
"issues": [
{
"path": "email",
"message": "Invalid email"
}
]
}