time_off_balances
List organization time off balances
Returns time off balances for the given organization.
Each entry represents one user's balance for one time off policy in the requested year.
Use year to query balances for a specific year (defaults to current year in the organization's timezone).
Use include[] to sideload related users and time_off_policies.
get/v2/organizations/{organization_id}/time_off_balances
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
organization_idinteger required
Query parameters
page_start_idinteger
The page start ID.
page_limitinteger
The default page size
searchstring
User name search
user_idsinteger[]
Filter by user IDs
time_off_policy_idsinteger[]
Filter by time off policy IDs
yearinteger
Balance year (default: current year in organization timezone)
includestring[]
Specify related data to side load.
Response
A list of time off balances
Changes
No recorded changes to this operation across all 1 revision of this API.