Skip to main content
GET
/
leave-requests
curl -X GET "https://api.companyflow.com/leave-requests?page=1&pageSize=20&status=pending" \
  -H "Authorization: Bearer YOUR_TOKEN"

{
  "success": true,
  "data": {
    "items": [
      {
        "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "employeeId": "987e6543-e21b-12d3-a456-426614174000",
        "leaveTypeId": "123e4567-e89b-12d3-a456-426614174000",
        "startDate": "2025-03-15T00:00:00Z",
        "endDate": "2025-03-19T00:00:00Z",
        "daysRequested": 5,
        "reason": "Family vacation",
        "attachmentUrl": null,
        "status": "pending",
        "currentStep": 1,
        "approvedBy": null,
        "approvedAt": null,
        "rejectionReason": "",
        "createdAt": "2025-03-03T10:30:00Z",
        "updatedAt": "2025-03-03T10:30:00Z"
      },
      {
        "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
        "employeeId": "987e6543-e21b-12d3-a456-426614174000",
        "leaveTypeId": "234f5678-f90c-23e4-b567-537725285111",
        "startDate": "2025-02-10T00:00:00Z",
        "endDate": "2025-02-12T00:00:00Z",
        "daysRequested": 3,
        "reason": "Medical appointment",
        "attachmentUrl": "https://storage.example.com/medical-cert.pdf",
        "status": "approved",
        "currentStep": 2,
        "approvedBy": "345a6789-a01d-34f5-c678-648836396222",
        "approvedAt": "2025-02-08T14:20:00Z",
        "rejectionReason": "",
        "createdAt": "2025-02-05T09:15:00Z",
        "updatedAt": "2025-02-08T14:20:00Z"
      }
    ],
    "total": 42,
    "page": 1,
    "pageSize": 20,
    "totalPages": 3
  }
}

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.

​
Overview

Retrieve all leave requests with support for pagination and filtering by employee, status, and date range. Managers and HR can view all requests, while employees see only their own requests.

​
Authentication

Requires authentication with Bearer token. Available to:
  • SuperAdmin
  • HR Manager
  • Manager
  • Employee (limited to own requests)

​
Query parameters

​
page
integer
default:"1"
Page number for pagination
​
pageSize
integer
default:"10"
Number of items per page (max: 100)
​
employeeId
string
Filter by employee UUID. Employees can only filter by their own ID.
​
status
string
Filter by request status. Available values:
  • pending - Awaiting approval
  • approved - Approved by manager
  • rejected - Rejected by manager
  • cancelled - Cancelled by system
  • withdrawn - Withdrawn by employee

​
Response

​
success
boolean
Indicates if the request was successful
​
data
object
Pagination wrapper containing leave requests
curl -X GET "https://api.companyflow.com/leave-requests?page=1&pageSize=20&status=pending" \
  -H "Authorization: Bearer YOUR_TOKEN"

{
  "success": true,
  "data": {
    "items": [
      {
        "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "employeeId": "987e6543-e21b-12d3-a456-426614174000",
        "leaveTypeId": "123e4567-e89b-12d3-a456-426614174000",
        "startDate": "2025-03-15T00:00:00Z",
        "endDate": "2025-03-19T00:00:00Z",
        "daysRequested": 5,
        "reason": "Family vacation",
        "attachmentUrl": null,
        "status": "pending",
        "currentStep": 1,
        "approvedBy": null,
        "approvedAt": null,
        "rejectionReason": "",
        "createdAt": "2025-03-03T10:30:00Z",
        "updatedAt": "2025-03-03T10:30:00Z"
      },
      {
        "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
        "employeeId": "987e6543-e21b-12d3-a456-426614174000",
        "leaveTypeId": "234f5678-f90c-23e4-b567-537725285111",
        "startDate": "2025-02-10T00:00:00Z",
        "endDate": "2025-02-12T00:00:00Z",
        "daysRequested": 3,
        "reason": "Medical appointment",
        "attachmentUrl": "https://storage.example.com/medical-cert.pdf",
        "status": "approved",
        "currentStep": 2,
        "approvedBy": "345a6789-a01d-34f5-c678-648836396222",
        "approvedAt": "2025-02-08T14:20:00Z",
        "rejectionReason": "",
        "createdAt": "2025-02-05T09:15:00Z",
        "updatedAt": "2025-02-08T14:20:00Z"
      }
    ],
    "total": 42,
    "page": 1,
    "pageSize": 20,
    "totalPages": 3
  }
}

​
Filtering examples

curl -X GET "https://api.companyflow.com/leave-requests?employeeId=987e6543-e21b-12d3-a456-426614174000" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Use cases

Manager dashboard

Retrieve all pending leave requests for team members to review and approve

Employee history

View personal leave history filtered by status and date range

HR reporting

Generate reports on leave usage across the organization

Team calendar

Display approved leave requests for team scheduling
Performance tip: Use pagination with reasonable page sizes (10-50 items) for optimal performance. The API enforces a maximum page size of 100.

Build docs developers (and LLMs) love

Get started for freeTalk to us