Sign in

v1

latestOpenAPI 3.1.02026-07-242735131.1 MB
Leave Policies

List Leave Policies Details

Describe the leave policies (custom or not) for a given employment

Scopes

CategoryRead only ScopeWrite only Scope (read access implicit)
Manage timeoffs (time_and_attendance)View timeoffs (timeoff:read)Manage timeoffs (timeoff:write)
get/v1/leave-policies/details/{employment_id}

Path parameters

employment_idstring required

Employment ID

Response

Success

Example response

{
  "data": [
    {
      "custom": true,
      "leave_policy_variant_id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Self-Care",
      "uses_accrual_as_balance": false
    }
  ]
}