Get Leave Request

Retrieve details of a specific leave request by ID

GET /leave-requests/{id}

cURL

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

Pending request

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

Overview

Fetch complete details of a single leave request including approval history, attached documents, and current status.

Authentication

Requires authentication with Bearer token. Available to:

• SuperAdmin
• HR Manager
• Manager
• Employee (own requests only)

Path parameters

id · string · required

UUID of the leave request to retrieve

Response

success · boolean

Indicates if the request was successful

data · object

The leave request object

Show LeaveRequest properties

id · string

Unique identifier for the leave request

employeeId · string

UUID of the employee who submitted the request

leaveTypeId · string

UUID of the leave type

startDate · string

Leave start date (ISO 8601 format)

endDate · string

Leave end date (ISO 8601 format)

daysRequested · number

Number of days requested (supports decimals for half days)

reason · string

Reason provided for the leave request

attachmentUrl · string

URL to attached documentation (e.g., medical certificate). Null if no attachment.

status · string

Current status of the request:

• pending - Awaiting approval
• approved - Approved by manager
• rejected - Rejected by manager
• cancelled - Cancelled by system
• withdrawn - Withdrawn by employee

currentStep · integer

Current step in the approval workflow (1-based index)

approvedBy · string

UUID of the manager who approved the request. Null if not yet approved.

approvedAt · string

Timestamp when the request was approved (ISO 8601). Null if not yet approved.

rejectionReason · string

Explanation provided by manager if request was rejected. Empty string if not rejected.

createdAt · string

Timestamp when the request was created (ISO 8601)

updatedAt · string

Timestamp of the last update (ISO 8601)

cURL

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

Pending request

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

Status definitions

pending

Leave request has been submitted and is awaiting manager review. Employee can still withdraw the request at this stage.

approved

Manager has approved the request. Leave days are deducted from the employee’s balance and the leave is confirmed.

rejected

Manager has rejected the request with a reason. No balance deduction occurs. Employee can submit a new request with different dates.

withdrawn

Employee has withdrawn their pending request before manager approval. No balance impact.

cancelled

System-cancelled due to policy changes or employee departure. Rare status for administrative purposes.

Related operations

After retrieving a leave request, you may want to:

Approve request

Approve a pending leave request (managers only)

Reject request

Reject a pending leave request with reason

Withdraw request

Employee can withdraw their own pending request

Check balance

View remaining leave balance for the employee

Error responses

Not found

{
  "success": false,
  "message": "leave request not found"
}