ZendeskList users
Lists the people in Zendesk, by role, group or organization.
Settings
| Setting | What it is |
|---|---|
| ConnectionRequired | The Zendesk connection the step signs in with. |
| Role | "" or "end-user" or "agent" or "admin" |
| Custom role id | Only agents with this custom role. Enterprise accounts only. |
| Your own id | Only the people carrying this external id. |
| Only this group | The List groups node gives you the id. |
| Only this organization | The List organizations node gives you the id. |
| People per call | 1 to 100. |
| Fetch every page | Follows Zendesk's cursor, 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 `zendesk`) |
role | "" or "end-user" or "agent" or "admin" |
permissionSet | text |
externalId | text |
groupId | text |
organizationId | text |
limit | number, by default 100 |
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 |
nextCursorCursor for the next page | string |
Sample output, and the expression for each field
- hasMorefalse
- nextCursor""
- 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": "",
"externalId": "",
"groupId": "",
"limit": 100,
"organizationId": "",
"permissionSet": "",
"returnAll": false,
"role": ""
},
"label": "List users",
"type": "zendesk.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 Zendesk connection the step signs in with. |
| Role | "" or "end-user" or "agent" or "admin" |
| Custom role id | Only agents with this custom role. Enterprise accounts only. |
| Your own id | Only the people carrying this external id. |
| Only this group | The List groups node gives you the id. |
| Only this organization | The List organizations node gives you the id. |
| People per call | 1 to 100. |
| Fetch every page | Follows Zendesk's cursor, and refuses past 5,000 people rather than answering a short list. |
Technical details
| Key | Value |
|---|---|
connection | texta connection id from `requires.connections` (provider `zendesk`) |
role | "" or "end-user" or "agent" or "admin" |
permissionSet | text |
externalId | text |
groupId | text |
organizationId | text |
limit | number, by default 100 |
returnAll | true/false, by default false |