v1

latestOpenAPI 3.1.02026-07-26294215839.4 KB
Time Off
Public API

List Time Off Policies

Returns all non-deleted time off policies for the company, sorted alphabetically by name. Only includes policies whose time off type has not been deleted.

OAuth Scopes: time_off

get/api/v1/meta/time_off/policies

Headers

AcceptHeaderParameter'application/xml' | 'application/json'

This endpoint can produce either JSON or XML.

Response

A list of all non-deleted time off policies, sorted alphabetically by name.

idinteger

The policy ID.

timeOffTypeIdinteger

The ID of the time off type this policy belongs to.

namestring

The policy name.

effectiveDatestring nullable

Deprecated. Always null.

type'accruing' | 'discretionary' | 'manual'

The policy type.