Sign in
Balance

Get balances for a policy

get/v1/workspaces/{workspaceId}/time-off/balance/policy/{policyId}

Path parameters

workspaceIdstring required

Represents a workspace identifier across the system.

Example:60f91b3ffdaf031696ec61a8

Represents a workspace identifier across the system.

policyIdstring required

Represents a policy identifier across the system.

Example:63034cd0cb0fb876a57e93ad

Represents a policy identifier across the system.

Query parameters

pageinteger
Example:1
page-sizeinteger
Example:50
sort'USER' | 'POLICY' | 'USED' | 'BALANCE' | 'TOTAL'

If provided, you'll get result sorted by sort column.

sort-order'ASCENDING' | 'DESCENDING'

Sort results in ascending or descending order.

Response

OK

Changes

Changed in 1 of the 2 revisions of this API.7

  • a5b636acbcd87See the full diff
    • ○

      the id response's property default value was added for the status 200

      response-property-default-value-added

    • ○

      the policyId response's property default value was added for the status 200

      response-property-default-value-added

    • ○

      the policyName response's property default value was added for the status 200

      response-property-default-value-added

    • ○

      the policyTimeUnit response's property default value was added for the status 200

      response-property-default-value-added

    • ○

      the userId response's property default value was added for the status 200

      response-property-default-value-added

    • ○

      the userName response's property default value was added for the status 200

      response-property-default-value-added

    • ○

      the workspaceId response's property default value was added for the status 200

      response-property-default-value-added