Time Off Tools
View and action staff time-off requests. List pending or approved requests, then approve or reject them.
Required scope: staff:read for list_time_off, staff:write for approve_time_off and reject_time_off.
Tools Overviewโ
| Tool | Description | Read-only? |
|---|---|---|
list_time_off | List staff time-off requests with optional filters | Yes |
approve_time_off | Approve a pending time-off request | No |
reject_time_off | Reject a pending time-off request | No |
list_time_offโ
List staff time-off requests. Filter by staff member, status, or date range. Returns up to 50 results ordered by start date descending.
Parametersโ
| Name | Type | Required | Description |
|---|---|---|---|
staff_id | integer | No | Filter by staff member |
status | string | No | Filter by status: pending, approved, rejected, cancelled |
start_date | string | No | Only return requests overlapping on or after this date (YYYY-MM-DD) |
end_date | string | No | Only return requests overlapping on or before this date (YYYY-MM-DD) |
Response Fieldsโ
Returns a time_off array. Each entry includes the request ID, staff_id, staff name, start_date, end_date, status, reason, and timestamps.
approve_time_offโ
Approve a pending staff time-off request. Records the approving user automatically.
Parametersโ
| Name | Type | Required | Description |
|---|---|---|---|
time_off_id | integer | Yes | Time-off request ID |
Response Fieldsโ
Returns success: true and the updated status value (approved), or an error if the request was not found.
reject_time_offโ
Reject a pending staff time-off request. Records the rejecting user automatically.
Parametersโ
| Name | Type | Required | Description |
|---|---|---|---|
time_off_id | integer | Yes | Time-off request ID |
Response Fieldsโ
Returns success: true and the updated status value (rejected), or an error if the request was not found.
Relatedโ
- Staff Tools - Staff member and shift management
- Schedule Tools - Check understaffing and copy schedule weeks
- Staff REST API - REST API endpoints for time off