Docs
/
/
Contact supportLog inGet started
Overview
Client libraries
API keys
Authentication
Rate limits
Batch rate limits
Idempotent requests
Data retention
Bulk endpoints
Trigger data filtering
Pagination
Errors
Common error codes
Get startedLog inContact support
Platform
Integrations
In-app UI
API reference
CLI reference
Management API
Developer tools
Tutorials

List channels

List the Microsoft Teams channels within a team. By default, archived and private channels are excluded from the results.

List channels

List the Microsoft Teams channels within a team. By default, archived and private channels are excluded from the results.

Endpoint

GET/v1/providers/ms-teams/{channel_id}/channels

Rate limit

Tier 2

Path parameters

channel_id
string

The ID of the Knock Microsoft Teams channel to get channels for.

Query parameters

ms_teams_tenant_object
string

A JSON encoded string containing the Microsoft Teams tenant object reference.

team_id
string

Microsoft Teams team ID.

query_options.$filter
string

OData param passed to the Microsoft Graph API to filter channels.

query_options.$select
string

OData param passed to the Microsoft Graph API to select specific properties.

Returns

ChannelsForMsTeamsProviderResponse

The response from a Microsoft Teams provider request, containing a list of channels.

ms_teams_channels
object[]

List of Microsoft Teams channels.

createdDateTime
string

Microsoft Teams channel created date and time.

description
string

Microsoft Teams channel description.

displayName
string
Required

Microsoft Teams channel name.

id
string
Required

Microsoft Teams channel ID.

isArchived
boolean

Whether the Microsoft Teams channel is archived.

membershipType
string

Microsoft Teams channel membership type.

New chat