List All Channels

Retrieve a paginated list of channels.

Required Permissions: manage_system

External Documentation

To learn more, visit the Mattermost documentation.

​

Parameters

Parameter	Description
Exclude Default Channels	Select to exclude the default channels from the returned list.
Exclude Policy Constrained	Select to exclude policy-constrained channels from the returned list.
Include Deleted	Select to include deleted items in the response.
Not Associated To Group	The group ID used to exclude channels from the results.
Page	The page number to retrieve, starting at 0.
Per Page	The maximum number of items to retrieve per page.
Return All Pages	Automatically 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"
	}
]