Employment HeroThis endpoint retrieves a paginated list of leave categories available within the specified organisation.
https:/api.employmenthero.com/api/v1/organisations/:organisation_id/leave_categoriesPath Parameters
The ID of the organisation to retrieve
Query Parameters
Current page index
11Number of items per page
20100Response Body
A hash with a data property that contains an array of leave category objects and pagination information.
Unique identifier for the leave category.
The name of the leave category.
The unit type for this leave category (e.g., days, hours).
The external identifier of the leave category, or null if it has none.
The type of the leave category, or null when no specific type applies.
Whether leave balances are not tracked for this leave category. May be null if not set.
Whether the leave balance is hidden for this leave category.
Whether the leave category is paid leave. May be null if not set.
Whether a reason is required when requesting this leave category.
Whether open-ended leave requests are allowed for this leave category.
Whether leave requests that would take the balance below zero are prevented.
What counts towards the balance when prevent_negative_leave_balance is true. Not used when prevent_negative_leave_balance is false.
Whether a note is required when requesting this leave category. May be null if not set.
Whether an attachment is optional, recommended or mandatory when requesting this leave category.
Whether non-working days within the leave period count towards the leave.
When the leave category or its settings were last updated (RFC 3339), whichever is later.
Current page index
11Number of items per page
20100Total items
Total pages
Example
curl -X GET \ "https://api.employmenthero.com/api/v1/organisations/:organisation_id/leave_categories" \ -H "Authorization: Bearer AUXJ3123xyrj123fdsjkl124aAJKQ"Response
{ "data": { "items": [ { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "name": "Annual Leave", "unit_type": "days", "external_id": "AL-001", "leave_category_type": null, "balance_untracked": false, "hide_balance": false, "paid": true, "requires_leave_reason": false, "is_open_ended_leave_request_allowed": false, "prevent_negative_leave_balance": false, "negative_leave_balance_prevention_mode": "approved_leave_only", "require_note": false, "attachment_requirement": "optional", "include_non_workdays": false, "updated_at": "2026-03-17T11:10:09+00:00" }, { "id": "b2c3d4e5-f6g7-8901-bcde-f23456789012", "name": "Sick Leave", "unit_type": "hours", "external_id": null, "leave_category_type": null, "balance_untracked": false, "hide_balance": false, "paid": true, "requires_leave_reason": false, "is_open_ended_leave_request_allowed": false, "prevent_negative_leave_balance": true, "negative_leave_balance_prevention_mode": "approved_and_pending_leave", "require_note": false, "attachment_requirement": "recommended", "include_non_workdays": false, "updated_at": "2026-04-02T08:45:00+00:00" }, { "id": "c3d4e5f6-g7h8-9012-cdef-345678901234", "name": "Personal Leave", "unit_type": "days", "external_id": null, "leave_category_type": null, "balance_untracked": false, "hide_balance": false, "paid": true, "requires_leave_reason": false, "is_open_ended_leave_request_allowed": false, "prevent_negative_leave_balance": false, "negative_leave_balance_prevention_mode": "approved_leave_only", "require_note": false, "attachment_requirement": "mandatory", "include_non_workdays": true, "updated_at": "2026-05-10T00:20:31+00:00" } ], "page_index": 1, "item_per_page": 20, "total_items": 3, "total_pages": 1 }}