FlowmageDocs

List clients

BetaReads dataVersion 2

Lists the clients in the Clockify workspace.

Settings

SettingWhat it is
ConnectionRequiredThe Clockify connection the step signs in with.
Workspace id overrideLeave 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.
Name containstext
Archived"" or "true" or "false"
Sort by"NAME" or "ID"
Direction"ASCENDING" or "DESCENDING"
Clients per call1 to 200. Clockify's own default is 50.
Fetch every pageWalks Clockify's pages, and refuses past 5,000 clients rather than answering a short list.
CursorPaste a previous run's Next cursor to read the page after it.
Technical details
KeyValue
connectiontexta connection id from `requires.connections` (provider `clockify`)
workspaceIdtexta value from the vendor's own list
nametext
archived"" or "true" or "false"
sortColumn"NAME" or "ID", by default "NAME"
sortOrder"ASCENDING" or "DESCENDING", by default "ASCENDING"
pageSizenumber, by default 50
returnAlltrue/false, by default false
cursortext

Output

FieldType
clientsarray
clientCountClients in this answernumber
hasMoreMore clients are waiting behind this pageboolean
nextPageThe page to ask for next, or 0number
nextCursorCursor for the next pagestring
Sample output, and the expression for each field
  • clientCount0
  • clients[]
  • hasMorefalse
  • nextPage0

Errors

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

Example step

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

{
  "config": {
    "archived": "",
    "connection": "<connection id>",
    "cursor": "",
    "name": "",
    "pageSize": 50,
    "returnAll": false,
    "sortColumn": "NAME",
    "sortOrder": "ASCENDING",
    "workspaceId": ""
  },
  "label": "List clients",
  "type": "clockify.listClients",
  "version": 2
}

Older versions

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

Version 1
SettingWhat it is
ConnectionRequiredThe Clockify connection the step signs in with.
Workspace id overrideLeave 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.
Name containstext
Archived"" or "true" or "false"
Sort by"NAME" or "ID"
Direction"ASCENDING" or "DESCENDING"
Clients per call1 to 200. Clockify's own default is 50.
Fetch every pageWalks Clockify's pages, and refuses past 5,000 clients rather than answering a short list.
Technical details
KeyValue
connectiontexta connection id from `requires.connections` (provider `clockify`)
workspaceIdtexta value from the vendor's own list
nametext
archived"" or "true" or "false"
sortColumn"NAME" or "ID", by default "NAME"
sortOrder"ASCENDING" or "DESCENDING", by default "ASCENDING"
pageSizenumber, by default 50
returnAlltrue/false, by default false