Sign in

v1

latestOpenAPI 3.1.02026-07-242735131.1 MB
Leave Policies

List Employee Leave Policies Summary

List the leave policies summary (balances and entitlements) for the current employee

Scopes

CategoryRead only ScopeWrite only Scope (read access implicit)
Manage timeoffs (time_and_attendance)View timeoffs (timeoff:read)Manage timeoffs (timeoff:write)
get/v1/employee/leave-policies/summary

Response

Success

Example response

{
  "data": [
    {
      "annual_balance": {
        "days": 1,
        "hours": 3,
        "type": "limited"
      },
      "annual_entitlement": {
        "days": 1,
        "hours": 3,
        "type": "limited"
      },
      "balance": {
        "days": 1,
        "hours": 3,
        "type": "limited"
      },
      "booked": {
        "days": 1,
        "hours": 3,
        "type": "limited"
      },
      "current_entitlement": {
        "days": 1,
        "hours": 3,
        "type": "limited"
      },
      "leave_policy": {
        "description": "Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque.",
        "leave_type": "sick_leave",
        "name": "Self-Care",
        "unit": "days"
      },
      "pending_approval": {
        "days": 1,
        "hours": 3,
        "type": "limited"
      },
      "taken": {
        "days": 1,
        "hours": 3,
        "type": "limited"
      },
      "upcoming_approved": {
        "days": 1,
        "hours": 3,
        "type": "limited"
      },
      "upcoming_requested": {
        "days": 1,
        "hours": 3,
        "type": "limited"
      },
      "used": {
        "days": 1,
        "hours": 3,
        "type": "limited"
      },
      "working_hours_per_day": 8
    }
  ]
}