Time Off
Public API

List Employee Time Off Policies

Changed on

Lists the time off policies assigned to an employee, with support for filtering and pagination. Ordered by effective date descending, so the most recent assignment is first. Only active assignments are returned; the archived and superceded rows the server keeps to track reassignment history are not surfaced. An active assignment may carry a past endDate: it remained in force up to that date and still contributes to historical accrual.

OAuth Scopes: time_off:policies

get/api/v1/employees/{employeeId}/time-off/policies

Request

Path parameters

employeeIdinteger required

The employee ID.

Query parameters

filterstring

OData filter expression applied to the employee's policy assignments. Supported operators: eq (equals, use eq null to match NULL), ne (not equals, use ne null to match NOT NULL), lt (less than), le (less than or equal), gt (greater than), ge (greater than or equal), in (value in list), and (combine clauses). Not supported: or, not, parenthesized grouping. Filterable fields: policyId, categoryId. Examples: policyId eq 15, categoryId in (62, 64), categoryId eq 64 and policyId eq 15.

pageinteger

The page number to retrieve. Rejected when the resulting offset would exceed the largest supported integer.

pageSizeinteger

The number of items to return per page.

Response

A paginated list of the employee's active time off policy assignments.

Example response

{
  "data": [
    {
      "id": 821,
      "employeeId": 40341,
      "policyId": 15,
      "categoryId": 64,
      "effectiveDate": "2022-05-02",
      "createdAt": "2025-05-27T22:34:07Z",
      "updatedAt": "2025-05-27T22:34:07Z",
      "status": "ACTIVE"
    }
  ]
}

Changes