Added
Time Off: Get Time Off Requests API
11 days ago by ReadMe API
You can now retrieve time-off requests programmatically via the Time Off API.
New Endpoint
GET /time-off/v1/requests— Get a paginated list of time-off requests whose date range overlaps the requested window
Key Features
- Date-range overlap: Pass
startDateandendDate(inclusive, up to 365 days) to fetch any request that overlaps the window. - Employee filter: Optionally pass
userIdsto limit results to specific employees. - Status filter: Filter by
approved,pending, ordenied. Defaults toapprovedwhen omitted. - Pagination: Use
limit(1–100, default 10) andoffsetto page through results. - Consistent response shape: Each item in
data.requests[]matches the Create time off request (POST) response, so you can reuse the same parsing model.
Authentication
- API Key (
X-API-KEYheader), or - OAuth 2.0 with scope
time_off.read
Use Cases
- Payroll and HR sync: Pull approved time off for a pay period and push it into your payroll or HRIS system.
- Integration dashboards: Surface pending requests alongside existing create/update flows.
- Audit and reporting: Export denied or pending requests for a date range without workarounds through other APIs.
For full details and examples, see the Get Time Off Requests Guide and the API Reference.
