v1
latestOpenAPI 3.1.02026-07-24172151607.6 KBChat
Retrieve Channels
This endpoint retrieves the Channels in a Workspace.
get/api/v3/workspaces/{workspace_id}/chat/channels
Path parameters
workspace_idinteger required
The ID of the Workspace.
Query parameters
description_format'text/md' | 'text/plain'
Format of the Channel description (Default: text/md).
cursorstring
Used to request the next page of results.
limitinteger
The maximum number of results to fetch for this page.
is_followerboolean
Only return Channels the user is following.
include_closedboolean
Include DMs/Group DMs that have been explicitly closed.
with_message_sincenumber
Only return Channels with at least one message since the given timestamp.
{"stackTrail":"components:schemas:ChatPublicApiChatChannelsControllerGetChatChannelsChannelTypesQuery","oasType":"schema","type":"unknown"}
Specify the types of Channels to return from the request.