Skip to main content
Get a channel by its name within a team. Required Permissions: read_channel for the channel.
External DocumentationTo learn more, visit the Mattermost documentation.

Parameters

ParameterDescription
Channel NameThe name of the channel to retrieve.
Include DeletedSelect to return the channel even if it has been deleted.
Team IDThe ID of the team.

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"
}

Workflow Library Example

Get Channel by Name with Mattermost and Send Results Via Email
Workflow LibraryPreview this Workflow on desktop