Balance

Get balances for a policy

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

Request

  • Base URL: https://api.clockify.me/api
  • URL: https://api.clockify.me/api/v1/workspaces/{workspaceId}/time-off/balance/policy/{policyId}
  • Auth: one of:
    • API key in header x-api-key
    • API key in header x-addon-token

Path parameters

workspaceIdstring required

Represents a workspace identifier across the system.

Example:60f91b3ffdaf031696ec61a8
policyIdstring required

Represents a policy identifier across the system.

Example:63034cd0cb0fb876a57e93ad

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

  • a5b636acbcd8Revision changes
    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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