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

# List Leave Types

> Get paginated list of leave types for a company

Retrieve a list of all leave types configured for a company with support for pagination, filtering, and search.

## Authentication

Requires authentication with Bearer token. Available to:

* **Super Admin**
* **HR Manager**
* **Employee**
* **Manager**

## Path Parameters

<ParamField path="company_id" type="string" required>
  The unique identifier of the company (UUID format)

  **Example:** `"123e4567-e89b-12d3-a456-426614174000"`
</ParamField>

## Query Parameters

<ParamField query="page" type="integer">
  Page number for pagination (starts at 1)

  **Default:** `1`
</ParamField>

<ParamField query="pageSize" type="integer">
  Number of items per page

  **Default:** `10`
</ParamField>

<ParamField query="status" type="string">
  Filter by leave type status: `active` or `inactive`

  **Example:** `"active"`
</ParamField>

<ParamField query="search" type="string">
  Search by name or code (case-insensitive)

  **Example:** `"annual"`
</ParamField>

## Response

<ResponseField name="success" type="boolean">
  Indicates if the request was successful
</ResponseField>

<ResponseField name="data" type="object">
  Paginated list of leave types

  <Expandable title="Pagination Object">
    <ResponseField name="items" type="array">
      Array of leave type objects

      <Expandable title="LeaveType properties">
        <ResponseField name="id" type="string">
          Unique identifier for the leave type
        </ResponseField>

        <ResponseField name="company_id" type="string">
          UUID of the company
        </ResponseField>

        <ResponseField name="name" type="string">
          Name of the leave type
        </ResponseField>

        <ResponseField name="code" type="string">
          Short code for the leave type
        </ResponseField>

        <ResponseField name="description" type="string">
          Detailed description
        </ResponseField>

        <ResponseField name="days_allowed" type="number">
          Total days allowed per year
        </ResponseField>

        <ResponseField name="is_paid" type="boolean">
          Whether the leave is paid
        </ResponseField>

        <ResponseField name="requires_documentation" type="boolean">
          Whether documentation is required
        </ResponseField>

        <ResponseField name="carry_forward_allowed" type="boolean">
          Whether carry forward is allowed
        </ResponseField>

        <ResponseField name="max_carry_forward_days" type="number">
          Maximum carry forward days
        </ResponseField>

        <ResponseField name="color_code" type="string">
          Hex color code
        </ResponseField>

        <ResponseField name="status" type="string">
          Status: active or inactive
        </ResponseField>

        <ResponseField name="created_at" type="string">
          ISO 8601 timestamp
        </ResponseField>

        <ResponseField name="updated_at" type="string">
          ISO 8601 timestamp
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="total" type="integer">
      Total number of leave types matching the filters
    </ResponseField>

    <ResponseField name="page" type="integer">
      Current page number
    </ResponseField>

    <ResponseField name="pageSize" type="integer">
      Number of items per page
    </ResponseField>

    <ResponseField name="totalPages" type="integer">
      Total number of pages
    </ResponseField>
  </Expandable>
</ResponseField>

<RequestExample>
  ```bash cURL theme={null}
  curl -X GET "https://api.companyflow.com/companies/123e4567-e89b-12d3-a456-426614174000/leave-types?page=1&pageSize=10&status=active" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://api.companyflow.com/companies/123e4567-e89b-12d3-a456-426614174000/leave-types?page=1&pageSize=10&status=active',
    {
      method: 'GET',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  url = 'https://api.companyflow.com/companies/123e4567-e89b-12d3-a456-426614174000/leave-types'
  headers = {
      'Authorization': 'Bearer YOUR_TOKEN'
  }
  params = {
      'page': 1,
      'pageSize': 10,
      'status': 'active'
  }

  response = requests.get(url, headers=headers, params=params)
  data = response.json()
  ```
</RequestExample>

<ResponseExample>
  ```json 200 - Success theme={null}
  {
    "success": true,
    "data": {
      "items": [
        {
          "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
          "company_id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "Annual Leave",
          "code": "AL",
          "description": "Paid annual vacation time for all employees",
          "days_allowed": 20,
          "is_paid": true,
          "requires_documentation": false,
          "carry_forward_allowed": true,
          "max_carry_forward_days": 5,
          "color_code": "#3B82F6",
          "status": "active",
          "created_at": "2025-01-15T10:30:00Z",
          "updated_at": "2025-01-15T10:30:00Z"
        },
        {
          "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
          "company_id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "Sick Leave",
          "code": "SL",
          "description": "Paid sick leave with medical certificate",
          "days_allowed": 10,
          "is_paid": true,
          "requires_documentation": true,
          "carry_forward_allowed": false,
          "max_carry_forward_days": 0,
          "color_code": "#EF4444",
          "status": "active",
          "created_at": "2025-01-15T10:35:00Z",
          "updated_at": "2025-01-15T10:35:00Z"
        }
      ],
      "total": 2,
      "page": 1,
      "pageSize": 10,
      "totalPages": 1
    }
  }
  ```

  ```json 400 - Bad Request theme={null}
  {
    "success": false,
    "message": "invalid company_id"
  }
  ```

  ```json 401 - Unauthorized theme={null}
  {
    "success": false,
    "message": "unauthorized"
  }
  ```
</ResponseExample>

## Filtering and Search

<Tip>
  Combine multiple query parameters to refine your results:

  * Use `status=active` to see only active leave types
  * Use `search=sick` to find leave types containing "sick" in name or code
  * Use pagination parameters to control result size
</Tip>