Skip to main content

Get Channel

Retrieves detailed information about a specific channel within a Microsoft Teams team.

Common Properties​

  • Name - The custom name of the node.
  • Color - The custom color of the node.
  • Delay Before (sec) - Waits in seconds before executing the node.
  • Delay After (sec) - Waits in seconds after executing node.
  • Continue On Error - Automation will continue regardless of any error. The default value is false.
info

If ContinueOnError property is true, no error is caught when the project is executed even if Catch node is used.

Input​

  • Client Id - The client ID from the Connect node. Optional if using direct credentials.
  • Team Id - The unique identifier of the team containing the channel (required).
  • Channel Id - The unique identifier of the channel to retrieve (required).

Output​

  • Channel - Channel object containing:
    • Id - Unique identifier
    • DisplayName - Channel name
    • Description - Channel description
    • MembershipType - Type (Standard, Private, etc.)
    • WebUrl - Link to channel in Teams
    • Additional channel metadata

Options​

  • Credentials - OAuth2 credentials JSON (optional if using Client ID). Allows direct authentication without Connect node.

Examples​

Get Channel Details​

Retrieve information about a specific channel:

team_id = "19:abc123def456..."
channel_id = "19:xyz789abc123..."

// Get Channel node
// Output: channel object

console.log("Channel: " + channel.DisplayName)
console.log("Description: " + channel.Description)
console.log("Type: " + channel.MembershipType)
console.log("URL: " + channel.WebUrl)

Verify Channel Before Posting​

Check channel exists before sending messages:

team_id = "19:abc123def456..."
channel_id = "19:xyz789abc123..."

// Get Channel node
channel = message.channel

// Verify channel details
if (channel.DisplayName === "Announcements") {
    // Send Message node
    // Post announcement to verified channel
}

Find Channel by Name​

Get channel ID from name:

team_id = "19:abc123def456..."
channel_name = "Development"

// ListChannels node
channels = message.channels.value

// Find by name
found = channels.find(ch =>
    ch.DisplayName === channel_name
)

if (found) {
    // Get Channel for full details
    channel_id = found.Id
    // Get Channel node
}

Tips for Effective Use​

  • Validate first: Use to verify channel before operations
  • Get metadata: Access channel settings and properties
  • Cache data: Store channel info to reduce API calls
  • Error handling: Handle cases where channel doesn't exist

Common Errors and Solutions​

"Team Id cannot be empty"​

Cause: No team ID provided.

Solution: Provide valid team ID from ListTeams or team object.

"Channel Id cannot be empty"​

Cause: No channel ID provided.

Solution: Get channel ID from ListChannels first.

Channel Not Found​

Cause: Channel doesn't exist or was deleted.

Solution: Use ListChannels to get current channel list.