Get Leave Type

curl -X GET https://api.companyflow.com/leave-types/a1b2c3d4-e5f6-7890-abcd-ef1234567890 \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://api.companyflow.com/leave-types/a1b2c3d4-e5f6-7890-abcd-ef1234567890',
  {
    method: 'GET',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

url = 'https://api.companyflow.com/leave-types/a1b2c3d4-e5f6-7890-abcd-ef1234567890'
headers = {
    'Authorization': 'Bearer YOUR_TOKEN'
}

response = requests.get(url, headers=headers)
data = response.json()

{
  "success": true,
  "data": {
    "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"
  }
}

{
  "success": false,
  "message": "invalid leave type id"
}

{
  "success": false,
  "message": "unauthorized"
}

{
  "success": false,
  "message": "internal server error"
}

GET

leave-types

{id}

curl -X GET https://api.companyflow.com/leave-types/a1b2c3d4-e5f6-7890-abcd-ef1234567890 \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://api.companyflow.com/leave-types/a1b2c3d4-e5f6-7890-abcd-ef1234567890',
  {
    method: 'GET',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

url = 'https://api.companyflow.com/leave-types/a1b2c3d4-e5f6-7890-abcd-ef1234567890'
headers = {
    'Authorization': 'Bearer YOUR_TOKEN'
}

response = requests.get(url, headers=headers)
data = response.json()

{
  "success": true,
  "data": {
    "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"
  }
}

{
  "success": false,
  "message": "invalid leave type id"
}

{
  "success": false,
  "message": "unauthorized"
}

{
  "success": false,
  "message": "internal server error"
}

Get detailed information about a specific leave type configuration.

Authentication

Requires authentication with Bearer token. Available to:

Super Admin
HR Manager
Employee
Manager

Path Parameters

string

required

The unique identifier of the leave type (UUID format)Example: "a1b2c3d4-e5f6-7890-abcd-ef1234567890"

Response

boolean

Indicates if the request was successful

object

The leave type object

Show LeaveType properties

string

Unique identifier for the leave type

string

UUID of the company

string

Name of the leave type

string

Short code for the leave type

string

Detailed description

number

Total days allowed per year

boolean

Whether the leave is paid

boolean

Whether documentation is required

boolean

Whether carry forward is allowed

number

Maximum carry forward days

string

Hex color code for calendar display

string

Status: active or inactive

string

ISO 8601 timestamp of when created

string

ISO 8601 timestamp of last update

curl -X GET https://api.companyflow.com/leave-types/a1b2c3d4-e5f6-7890-abcd-ef1234567890 \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://api.companyflow.com/leave-types/a1b2c3d4-e5f6-7890-abcd-ef1234567890',
  {
    method: 'GET',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

url = 'https://api.companyflow.com/leave-types/a1b2c3d4-e5f6-7890-abcd-ef1234567890'
headers = {
    'Authorization': 'Bearer YOUR_TOKEN'
}

response = requests.get(url, headers=headers)
data = response.json()

{
  "success": true,
  "data": {
    "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"
  }
}

{
  "success": false,
  "message": "invalid leave type id"
}

{
  "success": false,
  "message": "unauthorized"
}

{
  "success": false,
  "message": "internal server error"
}

Use Cases

This endpoint is useful for:

Displaying leave type details in a form before submitting a leave request
Showing leave policies to employees
Verifying leave type configuration
Building leave request interfaces

All authenticated employees can view leave type details, but only Super Admin and HR Manager roles can modify leave types.

Authentication

Companies

Employees

Departments

Designations

Levels

Roles & Permissions

Leave Types

Leave Requests

Leave Balances

Memos

Approvals

Authentication

Path Parameters

Response

Use Cases

​Authentication

​Path Parameters

​Response

​Use Cases

Authentication

Path Parameters

Response

Use Cases