Create time off request
Creates a new time off request.
Returns the created time off request with a balance_preview showing the policy balance impact.
time_off_request_days must include one entry for every date from starts_at to stops_at. Each entry requires a date and amount_used in seconds (typically 28800 for an 8-hour day). Set amount_used to 0 for excluded weekend or holiday days.
Set require_no_shift_overlap to true to reject the request if it overlaps with scheduled attendance shifts.
remove_shifts deletes overlapping attendance shifts only when the policy does not require approval (the request is auto-approved on creation). When the policy requires approval, this field is ignored — use the status endpoint to remove shifts at approval time instead.
Note: starts_at and stops_at are interpreted as wall-clock times in the target user's configured timezone (any timezone offset in the value is ignored). When all_day is true, the response covers the whole local day, 00:00:00.000–23:59:59.999 in the timezone saved with the request when it was created.
Request
- Base URLhttps://api.hubstaff.com
- AuthOAuth 2Authorization codehttps://account.hubstaff.com/authorizations/newToken URLhttps://account.hubstaff.com/access_tokensScopeshubstaff:read, hubstaff:write
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
Request body
Response
A time off request with its balance preview
Changes
No recorded changes to this operation across all 1 revision of this API.