Channel.ReadBasic.All
Read all channel names and channel descriptions, without a signed-in user.
Permission Details
Read the names and descriptions of all channels
Read all channel names and channel descriptions, without a signed-in user.
59a6b24b-4225-4393-8165-ebaec5f55d7a
Read the names and descriptions of channels
Read channel names and channel descriptions, on behalf of the signed-in user.
9d8982ae-4365-4f57-95e9-d6032a4c0b87
Properties
Properties is shown from stable Microsoft Graph v1.0 metadata.
| Property | Type | Description |
|---|---|---|
createdDateTime |
dateTimeOffsetNullable |
Read only. Timestamp at which the channel was created. |
description |
StringNullable |
Optional textual description for the channel. |
displayName |
String |
Channel name as it will appear to the user in Microsoft Teams. The maximum length is 50 characters. |
email |
StringNullable |
The email address for sending messages to the channel. Read-only. |
id |
String |
The channel's unique identifier. Read-only. |
isArchived |
BooleanNullable |
Indicates whether the channel is archived. Read-only. |
isFavoriteByDefault |
BooleanNullable |
Indicates whether the channel should be marked as recommended for all members of the team to show in their channel list. Note: All recommended channels automatically show in the channels list for education and frontline worker users. The property can only be set programmatically via the Create team method. The default value is false. |
membershipType |
channelMembershipType |
The type of the channel. Can be set during creation and can't be changed. The possible values are: standard, private, unknownFutureValue, shared. The default value is standard. Use the Prefer: include-unknown-enum-members request header to get the following members in this evolvable enum: shared. |
tenantId |
stringNullable |
The ID of the Microsoft Entra tenant. |
webUrl |
StringNullable |
A hyperlink that will go to the channel in Microsoft Teams. This is the URL that you get when you right-click a channel in Microsoft Teams and select Get link to channel. This URL should be treated as an opaque blob, and not parsed. Read-only. |
summary |
channelSummary |
Contains summary information about the channel, including number of owners, members, guests, and an indicator for members from other tenants. The summary property will only be returned if it is specified in the $select clause of the Get channel method. |
@microsoft.graph.channelCreationMode |
string |
Indicates that the channel is in migration state and is currently being used for migration purposes. It accepts one value: migration. |
allMembers |
conversationMember collection |
A collection of membership records associated with the channel, including both direct and indirect members of shared channels. |
filesFolder |
object |
Metadata for the location where the channel's files are stored. |
members |
conversationMember collection |
A collection of membership records associated with the channel. |
Showing 15 of 18 properties.
JSON Representation
JSON representation is shown from stable Microsoft Graph v1.0 metadata.
{
"createdDateTime": "String (timestamp)",
"description": "String",
"displayName": "String",
"email": "String",
"id": "String (identifier)",
"isArchived": "Boolean",
"isFavoriteByDefault": "Boolean",
"membershipType": "String",
"webUrl": "String"
}
Relationships
Relationships is shown from stable Microsoft Graph v1.0 metadata.
| Relationship | Type | Description |
|---|---|---|
allMembers |
conversationMember collection |
A collection of membership records associated with the channel, including both direct and indirect members of shared channels. |
enabledApps |
teamsApp collection |
A collection of enabled apps in the channel. |
filesFolder |
driveItem |
Metadata for the location where the channel's files are stored. |
members |
conversationMember collection |
A collection of membership records associated with the channel. |
messages |
chatMessage collection |
A collection of all the messages in the channel. A navigation property. Nullable. |
operations |
teamsAsyncOperation collection |
The async operations that ran or are running on this team. |
sharedWithTeams |
sharedWithChannelTeamInfo collection |
A collection of teams with which a channel is shared. |
tabs |
teamsTab collection |
A collection of all the tabs in the channel. A navigation property. |
Graph Methods
Microsoft Graph v1.0 endpoints are mapped directly from refreshed Microsoft Learn permissions tables.
| Methods |
|---|
GET
/teams/{id}/primaryChannel
|
GET
/teams/{team-id}/allChannels
|
GET
/teams/{team-id}/channels
|
GET
/teams/{team-id}/channels/{channel-id}
|
GET
/teams/{team-id}/incomingChannels
|
Microsoft Graph beta endpoints are mapped directly from refreshed Microsoft Learn permissions tables.
| Methods |
|---|
GET
/teams/{id}/primaryChannel
|
GET
/teams/{team-id}/allChannels
|
GET
/teams/{team-id}/channels
|
GET
/teams/{team-id}/channels/{channel-id}
|
GET
/teams/{team-id}/incomingChannels
|
Microsoft Graph PowerShell v1.0 commands are mapped directly from refreshed Microsoft Learn PowerShell snippets.
Microsoft Graph PowerShell beta commands are mapped directly from refreshed Microsoft Learn PowerShell snippets.
Code Examples
// Code snippets are only available for the latest version. Current version is 5.x
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Teams["{team-id}"].Channels["{channel-id}"].GetAsync();
const options = {
authProvider,
};
const client = Client.init(options);
let channel = await client.api('/teams/893075dd-2487-4122-925f-022c42e20265/channels/19:[email protected]')
.get();
Import-Module Microsoft.Graph.Teams
Get-MgTeamChannel -TeamId $teamId -ChannelId $channelId
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
result = await graph_client.teams.by_team_id('team-id').channels.by_channel_id('channel-id').get()
App Registration
Navigate to Azure Portal
Go to App registrations in Microsoft Entra admin center
Add API Permission
Select your app → API permissions → Add a permission → Microsoft Graph
Select Permission Type
Choose Application permissions or delegated permissions and search for Channel.ReadBasic.All
Grant Admin Consent
Application permissions always require admin consent.