---
updatedAt: 2026-04-27T16:09:54.000Z
agentTools:
  projectIndex: https://developer.deputy.com/llms.txt
---

# List leave balances for employee

List leave balances for employee.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Deputy V2 API",
    "version": "1.0",
    "description": "\n\nFiltered to publicly-authenticated routes only (APIAuthenticator). Scoped-OAuth routes and internal JWT routes are excluded — see the separate \"Deputy V2 Scoped API\" spec for scoped endpoints."
  },
  "servers": [
    {
      "url": "https://{subdomain}.{region}.deputy.com/api",
      "description": "Deputy tenant",
      "variables": {
        "subdomain": {
          "default": "your-subdomain",
          "description": "Your Deputy tenant subdomain"
        },
        "region": {
          "default": "deputy",
          "enum": [
            "au",
            "eu",
            "na",
            "deputy"
          ],
          "description": "Deputy region: au, eu, na, or deputy (AU default)"
        }
      }
    }
  ],
  "components": {
    "schemas": {
      "modelEmployeeStandardDayStandardDayCalculationMethod": {
        "type": "string",
        "enum": [
          "UNKNOWN_METHOD",
          "AGREED_HOURS",
          "DEFAULT_SHIFT",
          "REFERENCE_PERIOD",
          "LOCATION_DEFAULT_SHIFT",
          "EMPLOYMENT_CONDITION",
          "PER_EMPLOYEE_STANDARD_DAY"
        ],
        "default": "UNKNOWN_METHOD",
        "title": "Possible calculation methods"
      },
      "v2modelEmployeeStandardDay": {
        "type": "object",
        "properties": {
          "standardDayHours": {
            "type": "number",
            "format": "float",
            "title": "Employee standard day hours"
          },
          "standardDayCalcMethod": {
            "$ref": "#/components/schemas/modelEmployeeStandardDayStandardDayCalculationMethod",
            "title": "Standard day hours calculation method"
          },
          "defaultStandardDayHours": {
            "type": "number",
            "format": "float",
            "title": "The default value for standard day hours"
          }
        }
      },
      "LeaveBalanceForEmployeeAndLeaveRuleBalanceValue": {
        "type": "object",
        "properties": {
          "hours": {
            "type": "number",
            "format": "double",
            "title": "The balance value in hours"
          },
          "days": {
            "type": "number",
            "format": "double",
            "title": "The balance value in days"
          }
        },
        "title": "A balance value"
      },
      "LeaveBalanceForEmployeeAndLeaveRuleLeaveYearBalance": {
        "type": "object",
        "properties": {
          "yearName": {
            "type": "string",
            "title": "The name of the leave year"
          },
          "currentBalance": {
            "$ref": "#/components/schemas/LeaveBalanceForEmployeeAndLeaveRuleBalanceValue",
            "title": "The current balance value"
          },
          "upcomingLeave": {
            "$ref": "#/components/schemas/LeaveBalanceForEmployeeAndLeaveRuleBalanceValue",
            "title": "The amount of leave that has been requested and approved but not yet taken"
          },
          "availableBalance": {
            "$ref": "#/components/schemas/LeaveBalanceForEmployeeAndLeaveRuleBalanceValue",
            "title": "The amount of balance that is available to be requested (current balance - upcoming leave)"
          }
        },
        "title": "The balance for a given leave year"
      },
      "LeaveBalanceListLeaveBalancesForEmployeeResponse": {
        "type": "object",
        "properties": {
          "balances": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/modelLeaveBalanceForEmployeeAndLeaveRule"
            }
          }
        }
      },
      "modelLeaveBalanceForEmployeeAndLeaveRule": {
        "type": "object",
        "properties": {
          "leaveRule": {
            "$ref": "#/components/schemas/modelLeaveBalanceForEmployeeAndLeaveRuleLeaveRule",
            "title": "The leave rule"
          },
          "standardDay": {
            "$ref": "#/components/schemas/v2modelEmployeeStandardDay",
            "title": "The standard day for the employee"
          },
          "isVisibleToEmployee": {
            "type": "boolean",
            "title": "Whether the leave balance is visible to the employee"
          },
          "lastCalculatedAt": {
            "type": "string",
            "format": "date-time",
            "title": "The last time the leave balance was calculated"
          },
          "currentYear": {
            "$ref": "#/components/schemas/LeaveBalanceForEmployeeAndLeaveRuleLeaveYearBalance",
            "title": "The current leave year balance"
          },
          "futureYears": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/LeaveBalanceForEmployeeAndLeaveRuleLeaveYearBalance"
            },
            "title": "The leave year balances for future years"
          }
        },
        "title": "The leave balance information for an employee and leave rule"
      },
      "modelLeaveBalanceForEmployeeAndLeaveRuleLeaveRule": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int32",
            "title": "Leave rule id"
          },
          "name": {
            "type": "string",
            "title": "Leave rule name"
          },
          "unit": {
            "$ref": "#/components/schemas/modelLeaveBalanceForEmployeeAndLeaveRuleUnit",
            "title": "Leave rule unit"
          }
        },
        "title": "A leave rule"
      },
      "modelLeaveBalanceForEmployeeAndLeaveRuleUnit": {
        "type": "string",
        "enum": [
          "HOURS",
          "DAYS"
        ],
        "default": "HOURS",
        "title": "Unit that the leave balance is measured in"
      }
    },
    "securitySchemes": {
      "ApiToken": {
        "type": "apiKey",
        "in": "header",
        "name": "OAuth"
      }
    }
  },
  "paths": {
    "/management/v2/leave-balance/employees/{employeeId}/balances": {
      "get": {
        "operationId": "LeaveBalanceV2Controller_ListLeaveBalancesForEmployee",
        "responses": {
          "200": {
            "description": "A successful response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LeaveBalanceListLeaveBalancesForEmployeeResponse"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "employeeId",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "onlyVisibleToEmployee",
            "in": "query",
            "required": false,
            "schema": {
              "type": "boolean"
            }
          }
        ],
        "tags": [
          "Leave Balance"
        ],
        "summary": "List leave balances for employee",
        "description": "List leave balances for employee."
      }
    }
  },
  "security": [
    {
      "ApiToken": []
    }
  ]
}
```