v1

latestOpenAPI 3.1.02026-07-243113441.2 MB

Time Off Requests

Preview a time off request

Preview a time off request to see balance impact before creating

scope: time_off_requests:read

post/v1/companies/{company_uuid}/time_off/requests/preview

company_uuidstring required

The UUID of the company

X-Gusto-API-Version'2026-06-15'

Determines the date-based API version associated with your API call. If none is provided, your application's minimum API version is used.

request_uuidstring

The UUID of an existing time off request to preview changes for

employee_uuidstring required

The UUID of the employee

policy_uuidstring required

The UUID of the time off policy

start_datestring required

The start date of the time off request (YYYY-MM-DD)

end_datestring required

The end date of the time off request (YYYY-MM-DD)

daysobject required

An object where keys are dates in YYYY-MM-DD format and values are hours as string decimals (e.g. {"2025-01-20": "8.000"})

successful

balance_hoursstring nullable required

The employee's current available balance hours for this policy. Null for unlimited policies.

this_request_hoursstring required

The total hours for this time off request.

other_requested_hoursstring required

Hours from other pending or approved requests for this policy.

remaining_balance_hoursstring nullable required

The projected balance after this request is applied. Null for unlimited policies.

allow_negative_balanceboolean required

Whether the time off policy allows a negative balance.

unlimitedboolean required

Whether the time off policy provides unlimited time off.

{
  "balance_hours": "64.0",
  "this_request_hours": "16.0",
  "other_requested_hours": "0.0",
  "remaining_balance_hours": "48.0"
}