Get Channel By Name

Get a channel by its name within a team.

Required Permissions: read_channel for the channel.

External Documentation

To learn more, visit the Mattermost documentation.

​

Parameters

Parameter	Description
Channel Name	The name of the channel to retrieve.
Include Deleted	Select to return the channel even if it has been deleted.
Team ID	The ID of the team. Can be obtained from the List All Teams action.

​

Example Output

{
	"id": "string",
	"create_at": -9007199254740991,
	"update_at": -9007199254740991,
	"delete_at": -9007199254740991,
	"team_id": "string",
	"type": "string",
	"display_name": "string",
	"name": "string",
	"header": "string",
	"purpose": "string",
	"last_post_at": -9007199254740991,
	"total_msg_count": 0,
	"extra_update_at": -9007199254740991,
	"creator_id": "string"
}