Balance

Get balance for a user

Changed on
get/v1/workspaces/{workspaceId}/time-off/balance/user/{userId}

Request

  • Base URL: https://api.clockify.me/api
  • URL: https://api.clockify.me/api/v1/workspaces/{workspaceId}/time-off/balance/user/{userId}
  • 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
userIdstring required

Represents a user identifier across the system.

Example:60f924bafdaf031696ec6218

Query parameters

pagestring

Page number.

page-sizestring

Page size.

sort'USER' | 'POLICY' | 'USED' | 'BALANCE' | 'TOTAL'

Sort result based on given criteria

sort-order'ASCENDING' | 'DESCENDING'

Sort result by providing sort order.

Response

OK

Changes

  • a5b636acbcd8Revision changes
    • breaking

      for the query request parameter page, default value was added

    • breaking

      for the query request parameter page-size, default value was added

    • 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