Skip to main content
Retrieve a paginated list of channels. Required Permissions: manage_system
External DocumentationTo learn more, visit the Mattermost documentation.

​
Parameters

ParameterDescription
Exclude Default ChannelsSelect to exclude the default channels from the returned list.
Exclude Policy ConstrainedSelect to exclude policy-constrained channels from the returned list.
Include DeletedSelect to include deleted items in the response.
Not Associated To GroupThe group ID used to exclude channels from the results.
PageThe page number to retrieve, starting at 0.
Per PageThe maximum number of items to retrieve per page.
Return All PagesAutomatically fetch all resources, page by page.

​
Example Output

[
	{
		"id": "string",
		"create_at": 0,
		"update_at": 0,
		"delete_at": 0,
		"team_id": "string",
		"type": "string",
		"display_name": "string",
		"name": "string",
		"header": "string",
		"purpose": "string",
		"last_post_at": 0,
		"total_msg_count": 0,
		"extra_update_at": 0,
		"creator_id": "string",
		"team_display_name": "string",
		"team_name": "string",
		"team_update_at": 0,
		"policy_id": "string"
	}
]

​
Workflow Library Example

List All Channels with Mattermost and Send Results Via Email
Workflow LibraryPreview this Workflow on desktop