Retrieve a list of documents

Description

Returns a paginated list of documents.

GET /documents

🚧
Required OAuth Scopes:
file: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
name	`contains`
template	`eq`

Sorting Options

Name	Orders Supported
modified.dateTime	`asc`, `desc`
name	`asc`, `desc`

Code Samples

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

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

wget --method=GET "https://api.app.wdesk.com/platform/v1/documents" \
 --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/documents', headers = headers)

print(r.json())

Returns

200 - OK

Returns a JSON object with data and @nextLink properties. data contains a list of Document 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": "625efb2c141f482bb1cdab14ec18715d",
      "name": "2019 Year-End Summary",
      "created": {
        "dateTime": "2019-10-28T15:03:27Z"
      },
      "modified": {
        "dateTime": "2019-11-21T13:47:33Z"
      },
      "template": false
    },
    {
      "id": "233eae2b142f461bb2cfbb49ee58825b",
      "name": "2020 Projections",
      "created": {
        "dateTime": "2019-10-28T15:03:27Z"
      },
      "modified": {
        "dateTime": "2019-11-21T13:47:33Z"
      },
      "template": false
    }
  ],
  "@nextLink": "{opaqueUrl}"
}