For the complete documentation index, see llms.txt. This page is also available as Markdown.

ListChannels

Task to list channels from a Slack workspace.

Task version: 1.0.0

Required Frends version: 5.7+

Required .NET version: 8.0

Compatible Agents: Crossplatform

Task Parameters

Name
Description

🗝Token : String

Slack OAuth token used for authentication.

If the token is a bot token (starts with "xoxb"), messages

will be updated as the Slack app's bot user.

If the token is a user token (starts with "xoxp"), messages

will be updated as the Slack user who authorized the token.

The token owner must be the original message poster

or have appropriate permissions to edit the message.

Note: User tokens require the user to have authorized the app via OAuth

with appropriate scopes (e.g., "chat:write").

Default: - Example: xoxb-123456789

Name
Description

ExcludeArchived : Boolean

Whether to omit archived channels.

Default: True Example: true

Limit : Int32

Number of channels to return.

Default: 100 Example: 100

Cursor : String

A pagination cursor used to continue listing channels from where the previous ListChannels task execution stopped.

Set this to the NextCursor value returned in the previous result to fetch the next batch of channels.

Default: - Example: e3VzZXI6...

ThrowErrorOnFailure : Boolean

Whether to throw an error on failure.

Default: True Example: false

ErrorMessageOnFailure : String

Overrides the error message on failure.

Default: - Example: Custom error message

Task Result

Name
Description

Success : Boolean

Indicates if the task completed successfully. Example: true

Channels : List<Channel>

List of channels retrieved from the Slack workspace. Each channel includes its ID, name, and archive status. Example: { "Id": "C01234567", "Name": "general", "IsArchived": true }

HasMore : Boolean

Indicates whether more channels are available for pagination. If true, additional requests using a cursor may return more channels. Example: true

NextCursor : String

A pagination token to continue listing more channels. Use this value in the next execution of the ListChannels task to continue retrieving channels from where the previous execution ended. Example: dGVhbTpD...

Error : Error

Error that occurred during task execution. Example: object { string Message, object { Exception Exception } AdditionalInfo }

Task Changelog

Changelog for Task Frends.Slack.ListChannels.

[1.0.0] - 2025-08-01

Added

  • Initial implementation

Last updated

Was this helpful?