List channels

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

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

Path parameters

channel_idstring required

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

ms_teams_tenant_objectstring required

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

team_idstring required

Microsoft Teams team ID.

query_options.$filterstring

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

query_options.$selectstring

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

{
  "ms_teams_channels": [
    {
      "displayName": "General",
      "id": "channel-id-1"
    }
  ]
}