List members of a channel
Namespace: microsoft.graph
Retrieve a list of conversationMembers from a channel.
This method supports federation. Only a user who is a member of the shared channel can retrieve the channel member list.
Note
The membership IDs returned by server must be treated as opaque strings. The client should not try to parse or make any assumptions about these resource IDs.
The membership results could map to users from different tenants, as indicated in the response, in the future. The client should not assume that all members are from the current tenant only.
This API is available in the following national cloud deployments.
Global service | US Government L4 | US Government L5 (DOD) | China operated by 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
Permissions
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.
Permission type | Least privileged permissions | Higher privileged permissions |
---|---|---|
Delegated (work or school account) | Group.Read.All | ChannelMember.ReadWrite.All, ChannelMember.Read.All |
Delegated (personal Microsoft account) | Not supported. | Not supported. |
Application | ChannelMember.Read.All | ChannelMember.ReadWrite.All |
HTTP request
GET /teams/{team-id}/channels/{channel-id}/members
Optional query parameters
This method supports the $filter
, $select
, and $top
OData query parameters to help customize the response. The default and maximum page sizes are 100 and 999 objects respectively.
Request headers
Header | Value |
---|---|
Authorization | Bearer {token}. Required. Learn more about authentication and authorization. |
Request body
Don't supply a request body for this method.
Response
If successful, this method returns a 200 OK
response code and a conversationMember object in the response body.
Example
Request
The following example shows a request.
GET https://graph.microsoft.com/v1.0/teams/2ab9c796-2902-45f8-b712-7c5a63cf41c4/channels/19%3A20bc1df46b1148e9b22539b83bc66809%40thread.skype/members
Response
The following example shows the response.
Note: The response object shown here might be shortened for readability.
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#teams('2ab9c796-2902-45f8-b712-7c5a63cf41c4')/channels('19%3A20bc1df46b1148e9b22539b83bc66809%40thread.skype')/members",
"@odata.count": 2,
"value": [
{
"@odata.type": "#microsoft.graph.aadUserConversationMember",
"id": "MmFiOWM3OTYtMjkwMi00NWY4LWI3MTItN2M1YTYzY2Y0MWM0IyNlZWY5Y2IzNi0wNmRlLTQ2OWItODdjZC03MGY0Y2JlMzJkMTQ=",
"roles": [],
"displayName": "Jane Doe",
"userId": "eef9cb36-06de-469b-87cd-70f4cbe32d14",
"email": "[email protected]"
},
{
"@odata.type": "#microsoft.graph.aadUserConversationMember",
"id": "MmFiOWM3OTYtMjkwMi00NWY4LWI3MTItN2M1YTYzY2Y0MWM0IyNiMzI0NmY0NC1jMDkxLTQ2MjctOTZjNi0yNWIxOGZhMmM5MTA=",
"roles": [
"owner"
],
"displayName": "Ace John",
"userId": "b3246f44-c091-4627-96c6-25b18fa2c910",
"email": "[email protected]"
}
]
}