Clockify — Get time off balance

Settings

Setting	What it is
ConnectionRequired	The Clockify connection the step signs in with.
Workspace id override	Leave empty to use the workspace on the connection. Pick another workspace the same key can reach, or type its id — the List workspaces node gives you the ids.
User id	Empty reads the balances of the person the API key belongs to — the List users node gives you an id.
Sort by	"" or "USER" or "POLICY" or "USED" or "BALANCE" or "TOTAL"
Direction	"ASCENDING" or "DESCENDING"
Rows per call	1 to 200 — that is Clockify's own maximum here.
Fetch every page	Walks Clockify's pages, and refuses past 5,000 rows rather than answering a short list.
Cursor	Paste a previous run's Next cursor to read the page after it.

Technical details

Key	Value
`connection`	texta connection id from `requires.connections` (provider `clockify`)
`workspaceId`	texta value from the vendor's own list
`userId`	text
`sort`	"" or "USER" or "POLICY" or "USED" or "BALANCE" or "TOTAL"
`sortOrder`	"ASCENDING" or "DESCENDING", by default `"ASCENDING"`
`pageSize`	number, by default `50`
`returnAll`	true/false, by default `false`
`cursor`	text

Output

Field	Type
`balances`	array
`balanceCount`Balances in this answer	number
`hasMore`More balances are waiting behind this page	boolean
`nextPage`The page to ask for next, or 0	number
`nextCursor`Cursor for the next page	string

Sample output, and the expression for each field

balanceCount0
balances[]
hasMorefalse
nextPage0

Errors

When a step of this node stops a run, the run page shows a code. Look it up:

Clockify errors

15 codes

Common errors

93 codes

Example step

The step as a flow file holds it. Replace each value in <…>.

{
  "config": {
    "connection": "<connection id>",
    "cursor": "",
    "pageSize": 50,
    "returnAll": false,
    "sort": "",
    "sortOrder": "ASCENDING",
    "userId": "",
    "workspaceId": ""
  },
  "label": "Get time off balance",
  "type": "clockify.getTimeOffBalance",
  "version": 2
}

Older versions

A flow that already has this version keeps running it. A new step always gets the newest.

Version 1

Setting	What it is
ConnectionRequired	The Clockify connection the step signs in with.
Workspace id override	Leave empty to use the workspace on the connection. Pick another workspace the same key can reach, or type its id — the List workspaces node gives you the ids.
User id	Empty reads the balances of the person the API key belongs to — the List users node gives you an id.
Sort by	"" or "USER" or "POLICY" or "USED" or "BALANCE" or "TOTAL"
Direction	"ASCENDING" or "DESCENDING"
Rows per call	1 to 200 — that is Clockify's own maximum here.
Fetch every page	Walks Clockify's pages, and refuses past 5,000 rows rather than answering a short list.

Technical details

Key	Value
`connection`	texta connection id from `requires.connections` (provider `clockify`)
`workspaceId`	texta value from the vendor's own list
`userId`	text
`sort`	"" or "USER" or "POLICY" or "USED" or "BALANCE" or "TOTAL"
`sortOrder`	"ASCENDING" or "DESCENDING", by default `"ASCENDING"`
`pageSize`	number, by default `50`
`returnAll`	true/false, by default `false`

Get time off balance

SettingsCopy Anchor Link

OutputCopy Anchor Link

ErrorsCopy Anchor Link