Retrieve a list of tasks

Description

Returns a paginated list of tasks.

GET /tasks

🚧
Required OAuth Scopes:
task:read

Parameters

Parameter	In	Type	Required	Description
$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
assignee	`eq`
completed.dateTime	`eq`, `lt`, `gt`, `le`, `ge`
created.dateTime	`eq`, `lt`, `gt`, `le`, `ge`
dueDate	`eq`, `lt`, `gt`, `le`, `ge`
location.file	`eq`
location.fileSegment	`eq`
modified.dateTime	`eq`, `lt`, `gt`, `le`, `ge`
status	`eq`
title	`contains`

Sorting Options

Name	Orders Supported
assignee	`asc`, `desc`
completed.dateTime	`asc`, `desc`
created.dateTime	`asc`, `desc`
dueDate	`asc`, `desc`
modified.dateTime	`asc`, `desc`
status	`asc`, `desc`
title	`asc`, `desc`

Code Samples

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

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

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

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

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

print(r.json())

Returns

200 - OK

Returns a JSON object with data and @nextLink properties. data contains a list of Task 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.

Example Responses


{
  "data": [
    {
      "id": "129g274495354cf18edb6b3ea3d023b2",
      "title": "Review Document",
      "description": "Review document for spelling and grammar",
      "status": "Completed",
      "dueDate": "2019-10-30T00:00:00Z",
      "sourceUrl": "https://app.wdesk.com/tasks/d/UVdOauIzVaVkQjdxTmzNNUOEUTQOakEnTnpJTE9ENXkuEkdGeaF4OENNJEV3NUTBmA?token=NTc0NDU2MTg1MjM0ODUyTM",
      "completed": {
        "dateTime": "2019-10-29T15:03:27Z"
      },
      "modified": {
        "dateTime": "2019-10-29T15:03:27Z"
      },
      "assignee": {
        "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD",
        "displayName": "Jane Doe",
        "email": "[email protected]"
      },
      "created": {
        "user": {
          "id": "V3ZVc2VyFzV3NiQ5NDA2NjIzNxk2njH",
          "displayName": "John Doe",
          "email": "[email protected]"
        },
        "dateTime": "2019-10-28T15:03:27Z"
      },
      "location": {
        "file": "124efa2a142f472ba1ceab34ed18915f",
        "fileSegment": "465ttdh2a142y75ehsft5ab34edf5675"
      }
    },
    {
      "id": "120h274405355cf18ecb6b3ea3d023a7",
      "title": "Add example",
      "description": "Add an example of an object",
      "status": "Completed",
      "dueDate": "2019-10-29T00:00:00Z",
      "sourceUrl": "https://app.wdesk.com/tasks/d/UVdOauIzVaVkQjdxTmzNNUOEUTQOakEnTnpJTE9ENXkuEkdGeaF21ENNJEU3NUTBmB?token=NTc0NDU2MTk1MjM3ODDyTZ",
      "completed": {
        "dateTime": "2019-10-28T15:03:27Z"
      },
      "modified": {
        "dateTime": "2019-10-28T15:03:27Z"
      },
      "assignee": {
        "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD",
        "displayName": "Jane Doe",
        "email": "[email protected]"
      },
      "created": {
        "user": {
          "id": "V3ZVc2VyFzV3NiQ5NDA2NjIzNxk2njH",
          "displayName": "John Doe",
          "email": "[email protected]"
        },
        "dateTime": "2019-10-27T15:03:27Z"
      },
      "location": {
        "file": "124efa2a142f472ba1ceab34ed18915f",
        "fileSegment": "465ttdh2a142y75ehsft5ab34edf5675"
      }
    }
  ],
  "@nextLink": "{opaqueUrl}"
}