Overview

The Time Off API enables you to manage time-off policies, user balances, and time-off requests programmatically. Integrate with your HR systems to automate leave management.

Key Concepts

Policy Types

Policy types are categories of time off (e.g., Vacation, Sick Leave, Personal Days). Each policy type can contain multiple policies with different accrual rules.

Policies

Policies define the rules for a specific time-off type, including:

• Name (e.g., "Vacation - Full-time Employees")
• Unit (hours or days)
• Accrual and balance rules

Balances

Each user assigned to a policy has a balance - the amount of time off available to them.

Requests

Time-off requests are submitted by users (or on their behalf) and can be approved, pending, or denied.

---

Available Endpoints

Policy Types

Balances

Requests

Policy Assignments

---

Request Statuses

---

Balance Units

---

Constraints

---

Authentication

All endpoints require authentication via API key or OAuth 2.0.

Required Scopes

---

Workflow

1. Get policy types to understand available time-off categories
2. Assign users to policies with initial balances
3. Create requests for time off (as approved or pending)
4. Manage balances by updating as needed

📝

Note

Users must be assigned to a policy before you can create time-off requests or manage their balances for that policy type.

---

Guide Pages

---

API Reference