GuidesAPI ReferenceChangelogAPI StatusAPI PolicyGusto Security
API Reference

Preview a time off request

post
https://api.gusto-demo.com/v1/companies//time_off/requests/preview

Preview a time off request to see balance impact before creating

scope: time_off_requests:read

Path Params
string
required

The UUID of the company

Body Params
string

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

string
required

The UUID of the employee

string
required

The UUID of the time off policy

string
required

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

string
required

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

days
object
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"})

Headers
string
enum
Defaults to 2026-02-01

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

Allowed:
Responses

Updated 2 days ago

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 days ago