> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kuahr.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List leave types

> The types of leave the company offers (Annual, Sick, …). Requires the `leave:read` scope.



## OpenAPI

````yaml https://api.kuahr.com/openapi/v1.json get /v1/leave/types
openapi: 3.1.1
info:
  title: Kua API
  description: >-
    The Kua developer API — payroll, wallets, and payments for your own company.


    Authenticate with an API key issued from **Settings → API keys** in the
    dashboard, sent in the `X-Api-Key` header. Every request is scoped to the
    company that owns the key. Base URL: `https://api.kuahr.com` (all endpoints
    are versioned under `/v1`).
  version: v1
servers:
  - url: https://api.kuahr.com
    description: Production
security:
  - ApiKey: []
tags:
  - name: Payroll
    description: List and create payroll runs.
  - name: Employees
    description: Add people to your company.
  - name: Events
    description: The company event timeline (also delivered via webhooks).
  - name: Webhooks
    description: Register endpoints and inspect deliveries.
  - name: Test data
    description: Manage sandbox (test-mode) data.
  - name: Leave
    description: >-
      Time-off types, requests, balances, and allocations (requires the Leave
      add-on).
  - name: Advances
    description: Salary advances (requires the Salary advance add-on).
  - name: Performance
    description: OKRs, appraisals, and promotions (requires the Performance add-on).
paths:
  /v1/leave/types:
    get:
      tags:
        - Leave
      summary: List leave types
      description: >-
        The types of leave the company offers (Annual, Sick, …). Requires the
        `leave:read` scope.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/LeaveTypeDto'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
components:
  schemas:
    LeaveTypeDto:
      required:
        - id
        - name
        - defaultDaysPerYear
        - isPaid
        - maxCarryoverDays
        - genderRestriction
        - isActive
        - createdAt
      type: object
      properties:
        id:
          type: string
          description: The leave type's unique id.
          format: uuid
        name:
          type: string
          description: Display name, e.g. `Annual leave`.
        defaultDaysPerYear:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
            - integer
            - string
          description: Default entitlement granted per year.
          format: int32
        isPaid:
          type: boolean
          description: Whether time taken is paid.
        maxCarryoverDays:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
            - integer
            - string
          description: How many unused days may roll into next year.
          format: int32
        genderRestriction:
          type: string
          description: 'Who may take it: `Anyone`, `FemaleOnly`, or `MaleOnly`.'
        isActive:
          type: boolean
          description: Whether the type is currently offered.
        createdAt:
          type: string
          format: date-time
      description: A type of leave the company offers (e.g. Annual, Sick).
    ApiError:
      required:
        - code
        - message
      type: object
      properties:
        code:
          type: string
          description: >-
            A stable, machine-readable identifier you can branch on, e.g.
            `INSUFFICIENT_SCOPE`.
        message:
          type: string
          description: A human-readable explanation. May change; don't parse it.
      description: The standard error body returned for 4xx responses.
  securitySchemes:
    ApiKey:
      type: apiKey
      description: Your API key, e.g. `kua_live_…` (or `kua_test_…` in test mode).
      name: X-Api-Key
      in: header

````