FlowmageDocs

List channels

BetaReads dataVersion 2

Lists the Slack conversations this app can see.

Settings

SettingWhat it is
ConnectionRequiredThe Slack connection the step signs in with.
Kinds of conversationA comma list. A private channel only appears when the bot is a member of it.
Leave archived channels outtrue/false
Channels per call1 to 1000. Slack recommends 100 to 200.
Fetch every pageFollows Slack's page cursor, and refuses past 5,000 channels rather than answering a short list.
Workspace idOnly on an Enterprise Grid org, to read one workspace's channels.
CursorPaste a previous run's Next cursor to read the page after it.
Technical details
KeyValue
connectiontexta connection id from `requires.connections` (provider `slack`)
typestext, by default "public_channel"
excludeArchivedtrue/false, by default true
limitnumber, by default 200
returnAlltrue/false, by default false
teamIdtextits `{{ }}` must give a string
cursortext

Output

FieldType
channelsarray
channelCountChannels in this answernumber
hasMoreMore channels are waiting behind this pageboolean
nextCursorCursor for the next pagestring
Sample output, and the expression for each field
  • channelCount0
  • channels[]
  • hasMorefalse
  • nextCursor""

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": "",
    "excludeArchived": true,
    "limit": 200,
    "returnAll": false,
    "teamId": "",
    "types": "public_channel"
  },
  "label": "List channels",
  "type": "slack.listChannels",
  "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.
Kinds of conversationA comma list. A private channel only appears when the bot is a member of it.
Leave archived channels outtrue/false
Channels per call1 to 1000. Slack recommends 100 to 200.
Fetch every pageFollows Slack's page cursor, and refuses past 5,000 channels rather than answering a short list.
Workspace idOnly on an Enterprise Grid org, to read one workspace's channels.
Technical details
KeyValue
connectiontexta connection id from `requires.connections` (provider `slack`)
typestext, by default "public_channel"
excludeArchivedtrue/false, by default true
limitnumber, by default 200
returnAlltrue/false, by default false
teamIdtextits `{{ }}` must give a string