FlowmageDocs

List users

BetaReads dataVersion 2

Lists the people in a Slack workspace.

Settings

SettingWhat it is
ConnectionRequiredThe Slack connection the step signs in with.
People per callnumber
Fetch every pageFollows Slack's page cursor, and refuses past 5,000 people rather than answering a short list.
Workspace idOnly on an Enterprise Grid org, to read one workspace's people.
CursorPaste a previous run's Next cursor to read the page after it.
Technical details
KeyValue
connectiontexta connection id from `requires.connections` (provider `slack`)
limitnumber, by default 200
returnAlltrue/false, by default false
teamIdtextits `{{ }}` must give a string
cursortext

Output

FieldType
usersPeoplearray
userCountPeople in this answernumber
hasMoreMore people are waiting behind this pageboolean
nextCursorCursor for the next pagestring
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": "",
    "limit": 200,
    "returnAll": false,
    "teamId": ""
  },
  "label": "List users",
  "type": "slack.listUsers",
  "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 Slack connection the step signs in with.
People per callnumber
Fetch every pageFollows Slack's page cursor, and refuses past 5,000 people rather than answering a short list.
Workspace idOnly on an Enterprise Grid org, to read one workspace's people.
Technical details
KeyValue
connectiontexta connection id from `requires.connections` (provider `slack`)
limitnumber, by default 200
returnAlltrue/false, by default false
teamIdtextits `{{ }}` must give a string