Getting started

Before you start explore the Time off API to understand how the Public API supports time-off workflows and how to access Time off requests and policies

Required Permissions

To access time off policies via the API, ensure the following permissions are set:

Data type / Method	Permission	Comment
Policy Type & Policies	Features > Time off > Settings > Manage company's time off settings	Note that this is a "Features" permission

To learn more about setting permissions for service users, see API Service Users.

Rate limiting

Rate limits are restrictions that our API imposes on the number of times a user can access our endpoints within a specified period of time. To learn more about rate limiting best practices, see Rate limiting.

Below is a table detailing the rate limits for each endpoint in the Time off endpoints.

Method	Endpoint	Limit per minute
GET	Get Policy type reason codes	10
POST	Add a list of reason codes for a given policy type	10
GET	Get Policy type details	50
GET	Get all policy types names	50
GET	Get Policy details	50
GET	Get a list of policy names for a given policy type	50