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 balances and policies via the API, ensure the following permissions are set:
| Data type / Method | Permission | Comment |
|---|---|---|
| Get Requests | People's Data > Time off > See who's out today > See who's out | For all endpoints that fetch request details need to have this permission |
| Policy Type & Policies | Features > Time off > Settings > Manage company's time off settings | Note that this is a "Features" permission |
| Create request | Features > Time off > Settings > Manage company's time off settings & People's Data > Time off> Requests >Create, edit, and cancel people's requests that haven't been approved yet |
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 the balance for a given employee | 50 |
| POST | Create a balance adjustment | 10 |