Retrieve a list of tasks

Table Of Contents

Retrieve a list of tasks#

Deprecated

This endpoint is deprecated and may be removed in a future release.

This endpoint was deprecated on 2026-02-12.

It is scheduled for sunset on 2027-01-31.

Description#

Returns a paginated list of tasks. Currently this endpoint returns general tasks (such as those created as part of editing documents, sheets, and presentations) and tasks that have been associated with a Sustainability Program. It does not return tasks created as part of a process.

GET /prototype/platform/tasks

Required OAuth Scopes

task:read

Parameters#

Parameter	In	Type	Required	Description
X-Version	header	string	false	Version of the API (2022-01-01)
$filter	query	string	false	The properties to filter the results by.
$orderBy	query	string	false	One or more comma-separated expressions to indicate the order in which to sort the results.
$maxpagesize	query	integer	false	The maximum number of results to retrieve
$next	query	string	false	Pagination cursor for next set of results.

Filter Options#

Available logical operators: and

Name	Predicates Supported
approvalSteps.participants	`eq`, `in`
assignees	`eq`, `in`
created.dateTime	`eq`, `lt`, `gt`, `le`, `ge`
dueDate	`eq`, `lt`, `gt`, `le`, `ge`
location.resource	`eq`
location.segment	`eq`
modified.dateTime	`eq`, `lt`, `gt`, `le`, `ge`
status	`eq`
taskType	`contains`
title	`contains`

Sorting Options#

Name	Orders Supported
approvalSteps.participants	`asc`, `desc`
created.dateTime	`asc`, `desc`
dueDate	`asc`, `desc`
modified.dateTime	`asc`, `desc`
status	`asc`, `desc`
taskType	`asc`, `desc`
title	`asc`, `desc`

Code Samples#

curl

curl -X GET https://api.app.wdesk.com/prototype/platform/tasks \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer {access-token}' \
    -H 'X-Version: 2022-01-01'

httpie

http GET https://api.app.wdesk.com/prototype/platform/tasks \
    X-Version:2022-01-01 \
    Accept:application/json \
    Authorization:"Bearer {access-token}"

wget

wget --method=GET "https://api.app.wdesk.com/prototype/platform/tasks" \
    --output-document -  \ 
    --header 'Accept: application/json' \ 
    --header 'Authorization: Bearer {access-token}' \
    --header 'X-Version: 2022-01-01'

python

import requests

headers = {
  'X-Version': '2022-01-01',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.app.wdesk.com/prototype/platform/tasks', headers = headers)

print(r.json())

Returns#

200 - OK#

Returns a JSON object with data and @nextLink properties. data contains a list of PrototypeTask objects, and @nextLink provides the URL to the next set of results. If there are no additional results, @nextLink doesn’t appear. If the request returns no results at all, data contains an empty array.

400 - Bad Request#

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

401 - Unauthorized#

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

403 - Forbidden#

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

404 - Not Found#

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

409 - Conflict#

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

429 - Too Many Requests#

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

500 - Internal Server Error#

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

503 - Service Unavailable#

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

Example Responses#

200 Response

{
  "@nextLink": "<opaque_url>",
  "data": [
    {
      "approvalSteps": [
        {
          "completionMode": "ONE",
          "dueAt": null,
          "participants": [
            {
              "id": "V0ZVc2VyHzY0MTI5NzM0MzkxODg5OTI",
              "type": "USER"
            },
            {
              "id": "V0ZVc2VyHzU1MDg3OTc0MDE4MDg4OTY",
              "type": "USER"
            }
          ],
          "responses": [
            {
              "action": "APPROVE",
              "comment": "Changes are approved till eternity",
              "created": {
                "dateTime": "2023-06-11T13:00:00+00:00",
                "user_id": "V0ZVc2VyHzU1MDg3OTc0MDE4MDg4OTY"
              }
            }
          ]
        }
      ],
      "assignees": [
        {
          "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD",
          "type": "USER"
        }
      ],
      "created": {
        "dateTime": "2019-10-28T15:03:27Z",
        "user": {
          "displayName": "John Doe",
          "email": "john.doe@example.com",
          "id": "V3ZVc2VyFzV3NiQ5NDA2NjIzNxk2njH"
        }
      },
      "description": "Review document for spelling and grammar",
      "dueAt": "2019-10-30T00:00:00Z",
      "id": "129g274495354cf18edb6b3ea3d023b2",
      "location": {
        "resource": "124efa2a142f472ba1ceab34ed18915f",
        "segment": "465ttdh2a142y75ehsft5ab34edf5675"
      },
      "modified": {
        "dateTime": "2019-10-29T15:03:27Z"
      },
      "sourceUrl": "https://app.wdesk.com/tasks/d/UVdOauIzVaVkQjdxTmzNNUOEUTQOakEnTnpJTE9ENXkuEkdGeaF4OENNJEV3NUTBmA?token=NTc0NDU2MTg1MjM0ODUyTM",
      "status": "Completed",
      "title": "Review Document"
    },
    {
      "assignees": [
        {
          "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD",
          "type": "USER"
        }
      ],
      "created": {
        "dateTime": "2019-10-27T15:03:27Z",
        "user": {
          "displayName": "John Doe",
          "email": "john.doe@example.com",
          "id": "V3ZVc2VyFzV3NiQ5NDA2NjIzNxk2njH"
        }
      },
      "description": "Add an example of an object",
      "dueAt": "2019-10-29T00:00:00Z",
      "id": "120h274405355cf18ecb6b3ea3d023a7",
      "location": {
        "resource": "124efa2a142f472ba1ceab34ed18915f",
        "segment": "465ttdh2a142y75ehsft5ab34edf5675"
      },
      "modified": {
        "dateTime": "2019-10-28T15:03:27Z"
      },
      "sourceUrl": "https://app.wdesk.com/tasks/d/UVdOauIzVaVkQjdxTmzNNUOEUTQOakEnTnpJTE9ENXkuEkdGeaF21ENNJEU3NUTBmB?token=NTc0NDU2MTk1MjM3ODDyTZ",
      "status": "Completed",
      "title": "Add example"
    }
  ]
}

Bad Request

{
  "code": "400BadRequest",
  "message": "The request was unacceptable, often due to a missing or invalid parameter"
}

Unauthorized

{
  "code": "401Unauthorized",
  "message": "No valid API token provided"
}

Forbidden

{
  "code": "403Forbidden",
  "message": "The API token does not have permissions to perform the request"
}

Not Found

{
  "code": "404NotFound",
  "message": "The requested resource could not be found"
}

Conflict

{
  "code": "409Conflict",
  "message": "The request conflicts with another request"
}

Too Many Requests

{
  "code": "429TooManyRequests",
  "message": "Too many requests have been made against the API in too short a time"
}

Internal Server Error

{
  "code": "500InternalServerError",
  "message": "The server encountered an unexpected condition that prevented it from fulfilling the request"
}

Service Unavailable

{
  "code": "503ServiceUnavailable",
  "message": "The server cannot handle the request due to a temporary overload or scheduled maintenance"
}