ClockifyList users
Lists the people in the Clockify workspace, with their status and rates.
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. |
| E-mail contains | text |
| Name contains | text |
| On this project | Only the people who are members of one project. |
| Status | "" or "PENDING" or "ACTIVE" or "DECLINED" or "INACTIVE" or "ALL" |
| Include memberships | "" or "ALL" or "NONE" or "WORKSPACE" or "PROJECT" or "USERGROUP" |
| Include roles | Adds each person's manager roles to the answer. |
| Sort by | "" or "ID" or "EMAIL" or "NAME" or "NAME_LOWERCASE" or "ACCESS" or "HOURLYRATE" or "COSTRATE" |
| Direction | "ASCENDING" or "DESCENDING" |
| People per call | 1 to 200. Clockify's own default is 50. |
| Fetch every page | Walks Clockify's pages, and refuses past 5,000 people 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 |
email | text |
name | text |
projectId | text |
status | "" or "PENDING" or "ACTIVE" or "DECLINED" or "INACTIVE" or "ALL" |
memberships | "" or "ALL" or "NONE" or "WORKSPACE" or "PROJECT" or "USERGROUP" |
includeRoles | true/false, by default false |
sortColumn | "" or "ID" or "EMAIL" or "NAME" or "NAME_LOWERCASE" or "ACCESS" or "HOURLYRATE" or "COSTRATE" |
sortOrder | "ASCENDING" or "DESCENDING", by default "ASCENDING" |
pageSize | number, by default 50 |
returnAll | true/false, by default false |
cursor | text |
Output
| Field | Type |
|---|---|
usersPeople | array |
userCountPeople in this answer | number |
hasMoreMore people are waiting behind this page | boolean |
nextPageThe page to ask for next, or 0 | number |
nextCursorCursor for the next page | string |
Sample output, and the expression for each field
- hasMorefalse
- nextPage0
- userCount0
- users[]
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": {
"connection": "<connection id>",
"cursor": "",
"email": "",
"includeRoles": false,
"memberships": "",
"name": "",
"pageSize": 50,
"projectId": "",
"returnAll": false,
"sortColumn": "",
"sortOrder": "ASCENDING",
"status": "",
"workspaceId": ""
},
"label": "List users",
"type": "clockify.listUsers",
"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. |
| E-mail contains | text |
| Name contains | text |
| On this project | Only the people who are members of one project. |
| Status | "" or "PENDING" or "ACTIVE" or "DECLINED" or "INACTIVE" or "ALL" |
| Include memberships | "" or "ALL" or "NONE" or "WORKSPACE" or "PROJECT" or "USERGROUP" |
| Include roles | Adds each person's manager roles to the answer. |
| Sort by | "" or "ID" or "EMAIL" or "NAME" or "NAME_LOWERCASE" or "ACCESS" or "HOURLYRATE" or "COSTRATE" |
| Direction | "ASCENDING" or "DESCENDING" |
| People per call | 1 to 200. Clockify's own default is 50. |
| Fetch every page | Walks Clockify's pages, and refuses past 5,000 people 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 |
email | text |
name | text |
projectId | text |
status | "" or "PENDING" or "ACTIVE" or "DECLINED" or "INACTIVE" or "ALL" |
memberships | "" or "ALL" or "NONE" or "WORKSPACE" or "PROJECT" or "USERGROUP" |
includeRoles | true/false, by default false |
sortColumn | "" or "ID" or "EMAIL" or "NAME" or "NAME_LOWERCASE" or "ACCESS" or "HOURLYRATE" or "COSTRATE" |
sortOrder | "ASCENDING" or "DESCENDING", by default "ASCENDING" |
pageSize | number, by default 50 |
returnAll | true/false, by default false |