FlowmageDocs

List organizations

BetaReads dataVersion 2

Lists Zendesk organizations, or finds one by name or your own id.

Settings

SettingWhat it is
ConnectionRequiredThe Zendesk connection the step signs in with.
Find one byBoth searches match exactly, though upper and lower case do not matter.
Valuetext
Only this person's organizationsA person can belong to more than one organization.
Organizations per call1 to 100.
Fetch every pageFollows Zendesk's cursor, and refuses past 5,000 organizations 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 `zendesk`)
findBy"" or "name" or "externalId"
valuetextused when `findBy` is not ""
userIdtextused when `findBy` is ""
limitnumber, by default 100
returnAlltrue/false, by default false
cursortext

Output

FieldType
organizationsarray
organizationCountOrganizations in this answernumber
hasMoreMore organizations are waiting behind this pageboolean
nextCursorCursor for the next pagestring
Sample output, and the expression for each field
  • hasMorefalse
  • nextCursor""
  • organizationCount0
  • organizations[]

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": "",
    "findBy": "",
    "limit": 100,
    "returnAll": false,
    "userId": "",
    "value": ""
  },
  "label": "List organizations",
  "type": "zendesk.listOrganizations",
  "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 Zendesk connection the step signs in with.
Find one byBoth searches match exactly, though upper and lower case do not matter.
Valuetext
Only this person's organizationsA person can belong to more than one organization.
Organizations per call1 to 100.
Fetch every pageFollows Zendesk's cursor, and refuses past 5,000 organizations rather than answering a short list.
Technical details
KeyValue
connectiontexta connection id from `requires.connections` (provider `zendesk`)
findBy"" or "name" or "externalId"
valuetextused when `findBy` is not ""
userIdtextused when `findBy` is ""
limitnumber, by default 100
returnAlltrue/false, by default false