Planner: delta

Namespace: microsoft.graph


APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Retrieves changes to objects that the user is subscribed to.

This method allows your application to track changes to objects that the user can access from within Planner over time.

The return value of this method might contain hetergenous types of objects from Planner.

For more information about tracking changes in Microsoft Graph data, see Use delta query to track changes in Microsoft Graph data.


One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Permission type Permissions (from least to most privileged)
Delegated (work or school account) Tasks.Read, Tasks.ReadWrite, Group.Read.All, Group.ReadWrite.All
Delegated (personal Microsoft account) Not supported.
Application Not supported.

HTTP request

GET /me/planner/all/delta
GET /users/{id}/planner/all/delta

No additional query parameters (such as $select, $expand, or $filter) are currently supported on Planner's implementation of delta queries.

Request headers

Name Description
Authorization Bearer {token}. Required.

Request body

Do not supply a request body for this method.


If successful, this method returns a 200 OK response code and a collection of changes to be applied to objects in the response body, and a Delta Sync link to follow.

If the @odata.deltaLink that the caller uses is malformed, this endpoint will return HTTP 400.

If the @odata.deltaLink that the caller uses is too old, this endpoint will return HTTP 410.

This method can return any of the HTTP status codes. The most common errors that apps should handle for this method are the 403 and 404 responses. For more information about these errors, see Common Planner error conditions.



Here is an example of the request.


Here is an example of the response.

Note: The response object shown might be shortened for readability. All the changed properties will be returned from an actual call.

HTTP/1.1 200 OK
content-type: application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false;charset=utf-8
cache-control: private
client-request-id: 3acb384b-e2d1-4a46-a347-e03bc6428cac
request-id: 3acb384b-e2d1-4a46-a347-e03bc6428cac
preference-applied: odata.track-changes, odata.track-changes

    "@odata.context": "$metadata#Collection(microsoft.graph.plannerDelta)",
    "@odata.deltaLink": "$deltatoken=jVztGMFnm7qLEQ69FaXzWF5sPEJZU2YxZa32QEvnZTZ4q4C10ThM5uL7bEPm9ysqrxOY0QQIb4Uqmc9DH3rn7pczamvtCipDVJ4FivXh398.J9pSVKpytlutvx03-iBmO4ZM_3qPztOq2T9VIjHoRR0",
    "value": [
            "@odata.type": "#microsoft.graph.plannerTask",
            "@odata.etag": "W/\"JzEtVGFzayAgQEBAQEBAQEBAQEBAQEBASCc=\"",
            "percentComplete": 100,
            "completedDateTime": "2018-03-13T21:31:25.778Z",
            "completedBy": {
                "user": {
                    "id": "8414b634-316f-41ba-b6a6-646a2949e3a5"
            "id": "5pNWKnX2XUalCKa64-oiXJUAPT1v",
            "@odata.context": "$metadata#planner/tasks/$entity"
            "@odata.type": "#microsoft.graph.plannerTask",
            "@odata.etag": "W/\"JzEtVGFzayAgQEBAQEBAQEBAQEBAQEBATCc=\"",
            "percentComplete": 0,
            "completedDateTime": null,
            "completedBy": null,
            "id": "5pNWKnX2XUalCKa64-oiXJUAPT1v",
            "@odata.context": "$metadata#planner/tasks/$entity"
            "@odata.type": "#microsoft.graph.plannerTask",
            "@odata.etag": "W/\"JzEtVGFzayAgQEBAQEBAQEBAQEBAQEBAUCc=\"",
            "title": "Title change",
            "id": "5pNWKnX2XUalCKa64-oiXJUAPT1v",
            "@odata.context": "$metadata#planner/tasks/$entity"