API reference

List leave types

GET
/v1/leave-types

The organisation's annual leave types (no other kind of leave is available). Requires leave:read. Not paged.

Authorization

headerAuthorizationBearer <token>

OAuth 2.0 client credentials. Enter the client ID and client secret from Settings, API access; the token lasts one hour.

Response Body

All leave types.

application/json
  1. response
data*array<>
curl -X GET "https://example.com/v1/leave-types"
{  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "name": "string",      "category": "annual",      "is_paid": true,      "is_active": true    }  ]}