Skip to content

Commit b594fb2

Browse files
authored
Merge pull request #28645 from microsoftgraph/users/sumanac/changelogfornextlink
Document @odata.nextLink pagination support for Teams channel list APIs
2 parents 889e2b3 + a17d316 commit b594fb2

8 files changed

Lines changed: 99 additions & 11 deletions

File tree

api-reference/beta/api/channel-list.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,9 @@ Don't supply a request body for this method.
6161

6262
## Response
6363

64-
If successful, this method returns a `200 OK` response code and collection of [Channel](../resources/channel.md) objects in the response body.
64+
If successful, this method returns a `200 OK` response code and a collection of [channel](../resources/channel.md) objects in the response body.
65+
66+
When the result set spans multiple pages, the response includes an **@odata.nextLink** property with a URL for retrieving the next page of results. For details about how to page through results, see [Paging Microsoft Graph data in your app](/graph/paging).
6567

6668
## Examples
6769

api-reference/beta/api/team-list-allchannels.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,9 @@ Don't supply a request body for this method.
5454

5555
## Response
5656

57-
If successful, this method returns a `200 OK` response code and a collection of [channel](../resources/channel.md) objects in the response body. The response also includes the **@odata.id** property, which can be used to access the channel and run other operations on the [channel](../resources/channel.md) object.
57+
If successful, this method returns a `200 OK` response code and a collection of [channel](../resources/channel.md) objects in the response body. The response also includes the **@odata.id** property, which can be used to access the channel and run other operations on the [channel](../resources/channel.md) object.
58+
59+
When the result set spans multiple pages, the response includes an **@odata.nextLink** property with a URL for retrieving the next page of results. For details about how to page through results, see [Paging Microsoft Graph data in your app](/graph/paging).
5860

5961
> [!Note]
6062
> Currently, invoking the URL returned from the **@odata.id** property fails for cross-tenant shared channels. You can solve this issue if you remove the `/tenants/{tenant-id}` part from the URL before you call this API. For more information, see [Known issues with Microsoft Graph](/graph/known-issues#unable-to-access-a-cross-tenant-shared-channel-when-the-request-url-contains-tenantscross-tenant-id).

api-reference/beta/api/team-list-incomingchannels.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,9 @@ Don't supply a request body for this method.
4848

4949
## Response
5050

51-
If successful, this method returns a `200 OK` response code and a collection of [channel](../resources/channel.md) objects in the response body. The response also includes the **@odata.id** property which can be used to access the channel and run other operations on the [channel](../resources/channel.md) object.
51+
If successful, this method returns a `200 OK` response code and a collection of [channel](../resources/channel.md) objects in the response body. The response also includes the **@odata.id** property which can be used to access the channel and run other operations on the [channel](../resources/channel.md) object.
52+
53+
When the result set spans multiple pages, the response includes an **@odata.nextLink** property with a URL for retrieving the next page of results. For details about how to page through results, see [Paging Microsoft Graph data in your app](/graph/paging).
5254

5355
> [!Note]
5456
> Currently, invoking the URL returned from the **@odata.id** property fails for cross-tenant shared channels. You can solve this issue if you remove the `/tenants/{tenant-id}` part from the URL before you call this API. For more details, see [Known issues with Microsoft Graph](/graph/known-issues#unable-to-access-a-cross-tenant-shared-channel-when-the-request-url-contains-tenantscross-tenant-id).

api-reference/v1.0/api/channel-list.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,9 @@ Don't supply a request body for this method.
5858

5959
## Response
6060

61-
If successful, this method returns a `200 OK` response code and collection of [Channel](../resources/channel.md) objects in the response body.
61+
If successful, this method returns a `200 OK` response code and collection of [Channel](../resources/channel.md) objects in the response body.
62+
63+
When the result set spans multiple pages, the response includes an **@odata.nextLink** property with a URL for retrieving the next page of results. For details about how to page through results, see [Paging Microsoft Graph data in your app](/graph/paging).
6264

6365
## Examples
6466

api-reference/v1.0/api/team-list-allchannels.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,8 @@ Don't supply a request body for this method.
5252

5353
If successful, this method returns a `200 OK` response code and a collection of [channel](../resources/channel.md) objects in the response body. The response also includes the **@odata.id** property which can be used to access the channel and run other operations on the [channel](../resources/channel.md) object.
5454

55+
When the result set spans multiple pages, the response includes an **@odata.nextLink** property with a URL for retrieving the next page of results. For details about how to page through results, see [Paging Microsoft Graph data in your app](/graph/paging).
56+
5557
> [!Note]
5658
> Currently, invoking the URL returned from the **@odata.id** property fails for cross-tenant shared channels. You can solve this issue if you remove the `/tenants/{tenant-id}` part from the URL before you call this API. For more information, see [Known issues with Microsoft Graph](/graph/known-issues#unable-to-access-a-cross-tenant-shared-channel-when-the-request-url-contains-tenantscross-tenant-id).
5759

api-reference/v1.0/api/team-list-incomingchannels.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,8 @@ Don't supply a request body for this method.
4848

4949
If successful, this method returns a `200 OK` response code and a collection of [channel](../resources/channel.md) objects in the response body. The response also includes the **@odata.id** property which can be used to access the channel and run other operations on the [channel](../resources/channel.md) object.
5050

51+
When the result set spans multiple pages, the response includes an **@odata.nextLink** property with a URL for retrieving the next page of results. For details about how to page through results, see [Paging Microsoft Graph data in your app](/graph/paging).
52+
5153
> [!Note]
5254
> Currently, invoking the URL returned from the **@odata.id** property fails for cross-tenant shared channels. You can solve this issue if you remove the `/tenants/{tenant-id}` part from the URL before you call this API. For more details, see [Known issues with Microsoft Graph](/graph/known-issues#unable-to-access-a-cross-tenant-shared-channel-when-the-request-url-contains-tenantscross-tenant-id).
5355

changelog/Microsoft.Teams.Core.json

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5879,6 +5879,74 @@
58795879
"CreatedDateTime": "2025-01-14T18:15:55.2254479Z",
58805880
"WorkloadArea": "Teamwork and communications",
58815881
"SubArea": "Messaging"
5882+
},
5883+
{
5884+
"ChangeList": [
5885+
{
5886+
"Id": "f58e82d6-618a-4467-9662-2f2bef56b8cc",
5887+
"ApiChange": "Method",
5888+
"ChangedApiName": "GET",
5889+
"ChangeType": "Change",
5890+
"Description": "Updated the [List channels](https://learn.microsoft.com/en-us/graph/api/channel-list?view=graph-rest-beta) method on the [channel](https://learn.microsoft.com/en-us/graph/api/resources/channel?view=graph-rest-beta) resource to support **@odata.nextLink** pagination. With increased channel limits, responses might span multiple pages. Use **@odata.nextLink** to retrieve all results.",
5891+
"Target": "channel"
5892+
},
5893+
{
5894+
"Id": "f58e82d6-618a-4467-9662-2f2bef56b8cc",
5895+
"ApiChange": "Method",
5896+
"ChangedApiName": "List incomingChannels",
5897+
"ChangeType": "Change",
5898+
"Description": "Updated the [List incomingChannels](https://learn.microsoft.com/en-us/graph/api/team-list-incomingchannels?view=graph-rest-beta) method on the [team](https://learn.microsoft.com/en-us/graph/api/resources/team?view=graph-rest-beta) resource to support **@odata.nextLink** pagination. With increased channel limits, responses might span multiple pages. Use **@odata.nextLink** to retrieve all results.",
5899+
"Target": "team"
5900+
},
5901+
{
5902+
"Id": "f58e82d6-618a-4467-9662-2f2bef56b8cc",
5903+
"ApiChange": "Method",
5904+
"ChangedApiName": "List allChannels",
5905+
"ChangeType": "Change",
5906+
"Description": "Updated the [List allChannels](https://learn.microsoft.com/en-us/graph/api/team-list-allchannels?view=graph-rest-beta) method on the [team](https://learn.microsoft.com/en-us/graph/api/resources/team?view=graph-rest-beta) resource to support **@odata.nextLink** pagination. With increased channel limits, responses might span multiple pages. Use **@odata.nextLink** to retrieve all results.",
5907+
"Target": "team"
5908+
}
5909+
],
5910+
"Id": "f58e82d6-618a-4467-9662-2f2bef56b8cc",
5911+
"Cloud": "Prod",
5912+
"Version": "beta",
5913+
"CreatedDateTime": "2026-04-20T00:00:00.000Z",
5914+
"WorkloadArea": "Teamwork and communications",
5915+
"SubArea": "Messaging"
5916+
},
5917+
{
5918+
"ChangeList": [
5919+
{
5920+
"Id": "1ebea14c-d1fb-4932-be00-59d8ba313a4b",
5921+
"ApiChange": "Method",
5922+
"ChangedApiName": "GET",
5923+
"ChangeType": "Change",
5924+
"Description": "Updated the [List channels](https://learn.microsoft.com/en-us/graph/api/channel-list?view=graph-rest-1.0) method on the [channel](https://learn.microsoft.com/en-us/graph/api/resources/channel?view=graph-rest-1.0) resource to support **@odata.nextLink** pagination. With increased channel limits, responses might span multiple pages. Use **@odata.nextLink** to retrieve all results.",
5925+
"Target": "channel"
5926+
},
5927+
{
5928+
"Id": "1ebea14c-d1fb-4932-be00-59d8ba313a4b",
5929+
"ApiChange": "Method",
5930+
"ChangedApiName": "List incomingChannels",
5931+
"ChangeType": "Change",
5932+
"Description": "Updated the [List incomingChannels](https://learn.microsoft.com/en-us/graph/api/team-list-incomingchannels?view=graph-rest-1.0) method on the [team](https://learn.microsoft.com/en-us/graph/api/resources/team?view=graph-rest-1.0) resource to support **@odata.nextLink** pagination. With increased channel limits, responses might span multiple pages. Use **@odata.nextLink** to retrieve all results.",
5933+
"Target": "team"
5934+
},
5935+
{
5936+
"Id": "1ebea14c-d1fb-4932-be00-59d8ba313a4b",
5937+
"ApiChange": "Method",
5938+
"ChangedApiName": "List allChannels",
5939+
"ChangeType": "Change",
5940+
"Description": "Updated the [List allChannels](https://learn.microsoft.com/en-us/graph/api/team-list-allchannels?view=graph-rest-1.0) method on the [team](https://learn.microsoft.com/en-us/graph/api/resources/team?view=graph-rest-1.0) resource to support **@odata.nextLink** pagination. With increased channel limits, responses might span multiple pages. Use **@odata.nextLink** to retrieve all results.",
5941+
"Target": "team"
5942+
}
5943+
],
5944+
"Id": "1ebea14c-d1fb-4932-be00-59d8ba313a4b",
5945+
"Cloud": "Prod",
5946+
"Version": "v1.0",
5947+
"CreatedDateTime": "2026-04-20T00:00:00.000Z",
5948+
"WorkloadArea": "Teamwork and communications",
5949+
"SubArea": "Messaging"
58825950
}
58835951
]
58845952
}

concepts/whats-new-overview.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,11 @@ Manage Teams apps at the channel level within a team using the following APIs:
4949

5050
### Teamwork and communications | Messaging
5151

52-
Removed the `model` parameters and payment-model guidance from Microsoft Teams export APIs and related change-notification documentation. The `model` query parameter is no longer required and is ignored if supplied. For more information, see [Payment models and licensing requirements for Microsoft Teams APIs](/graph/teams-licenses).
52+
- Removed the `model` parameters and payment-model guidance from Microsoft Teams export APIs and related change-notification documentation. The `model` query parameter is no longer required and is ignored if supplied. For more information, see [Payment models and licensing requirements for Microsoft Teams APIs](/graph/teams-licenses).
53+
- The following Microsoft Teams APIs support **@odata.nextLink** pagination to handle increased channel limits. When the result set spans multiple pages, the response includes the **@odata.nextLink** property with a URL for retrieving the next page of results:
54+
- [List channels](/graph/api/channel-list)
55+
- [List incomingChannels](/graph/api/team-list-incomingchannels)
56+
- [List allChannels](/graph/api/team-list-allchannels)
5357

5458
## April 2026: New in preview only
5559

@@ -98,12 +102,16 @@ Use the **sensorTypes** property on [sensorCandidate](/graph/api/resources/secur
98102

99103
### Teamwork and communications | Messaging
100104

101-
Use the targeted messages APIs to manage messages in Microsoft Teams that are visible only to specified recipients within group chats or channels:
102-
- Use the [targetedChatMessage](/graph/api/resources/targetedchatmessage?view=graph-rest-beta&preserve-view=true) resource type to represent a targeted message in a chat or channel.
103-
- [Get all targeted messages](/graph/api/userteamwork-getalltargetedmessages?view=graph-rest-beta&preserve-view=true) sent to a user in group chats and channels for compliance and archiving purposes.
104-
- [Get all retained targeted messages](/graph/api/userteamwork-getallretainedtargetedmessages?view=graph-rest-beta&preserve-view=true) for a user, including messages deleted by the sender but preserved due to organizational retention policies.
105-
- [Delete a targeted message from a channel](/graph/api/userteamwork-deletetargetedmessage?view=graph-rest-beta&preserve-view=true) by providing the team ID, channel ID, and message ID.
106-
- [Delete a targeted message from a chat](/graph/api/chat-delete-targetedmessages?view=graph-rest-beta&preserve-view=true) by providing the chat ID and message ID.
105+
- Use the targeted messages APIs to manage messages in Microsoft Teams that are visible only to specified recipients within group chats or channels:
106+
- Use the [targetedChatMessage](/graph/api/resources/targetedchatmessage?view=graph-rest-beta&preserve-view=true) resource type to represent a targeted message in a chat or channel.
107+
- [Get all targeted messages](/graph/api/userteamwork-getalltargetedmessages?view=graph-rest-beta&preserve-view=true) sent to a user in group chats and channels for compliance and archiving purposes.
108+
- [Get all retained targeted messages](/graph/api/userteamwork-getallretainedtargetedmessages?view=graph-rest-beta&preserve-view=true) for a user, including messages deleted by the sender but preserved due to organizational retention policies.
109+
- [Delete a targeted message from a channel](/graph/api/userteamwork-deletetargetedmessage?view=graph-rest-beta&preserve-view=true) by providing the team ID, channel ID, and message ID.
110+
- [Delete a targeted message from a chat](/graph/api/chat-delete-targetedmessages?view=graph-rest-beta&preserve-view=true) by providing the chat ID and message ID.
111+
- The following Microsoft Teams APIs support **@odata.nextLink** pagination to handle increased channel limits. When the result set spans multiple pages, the response includes the **@odata.nextLink** property with a URL for retrieving the next page of results:
112+
- [List channels](/graph/api/channel-list?view=graph-rest-beta&preserve-view=true)
113+
- [List incomingChannels](/graph/api/team-list-incomingchannels?view=graph-rest-beta&preserve-view=true)
114+
- [List allChannels](/graph/api/team-list-allchannels?view=graph-rest-beta&preserve-view=true)
107115

108116
## March 2026: New and generally available
109117

0 commit comments

Comments
 (0)