Skip to main content
POST
Create a leave type

Authorizations

X-Api-Key
string
header
required

Your API key, e.g. kua_live_… (or kua_test_… in test mode).

Body

application/json
name
string
required
defaultDaysPerYear
required
isPaid
boolean
required
maxCarryoverDays
required
genderRestriction
null | string
required

Response

Created

A type of leave the company offers (e.g. Annual, Sick).

id
string<uuid>
required

The leave type's unique id.

name
string
required

Display name, e.g. Annual leave.

defaultDaysPerYear
required

Default entitlement granted per year.

isPaid
boolean
required

Whether time taken is paid.

maxCarryoverDays
required

How many unused days may roll into next year.

genderRestriction
string
required

Who may take it: Anyone, FemaleOnly, or MaleOnly.

isActive
boolean
required

Whether the type is currently offered.

createdAt
string<date-time>
required