List v2

POST

https://api.dropboxapi.com/2/file_requests/list_v2

POST

/2/file_requests/list_v2

import requests
url = "https://api.dropboxapi.com/2/file_requests/list_v2"
payload = { "limit": 1000 }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())

{
  "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu",
  "file_requests": [
    {
      "created": "2015-10-05T17:00:00Z",
      "file_count": 3,
      "id": "oaCAVmEyrqYnkZX9955Y",
      "is_open": true,
      "title": "Homework submission",
      "url": "https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y",
      "deadline": {
        "deadline": "2020-10-12T17:00:00Z",
        "allow_late_uploads": {
          ".tag": "seven_days"
        }
      },
      "description": "Please submit your homework here.",
      "destination": "/File Requests/Homework"
    },
    {
      "created": "2015-11-02T04:00:00Z",
      "file_count": 105,
      "id": "BAJ7IrRGicQKGToykQdB",
      "is_open": true,
      "title": "Photo contest submission",
      "url": "https://www.dropbox.com/request/BAJ7IrRGjcQKGToykQdB",
      "deadline": {
        "deadline": "2020-10-12T17:00:00Z"
      },
      "destination": "/Photo contest entries"
    },
    {
      "created": "2015-12-15T13:02:00Z",
      "file_count": 37,
      "id": "rxwMPvK3ATTa0VxOJu5T",
      "is_open": true,
      "title": "Wedding photo submission",
      "url": "https://www.dropbox.com/request/rxwMPvK3ATTa0VxOJu5T",
      "deadline": null,
      "destination": "/Wedding photos"
    }
  ],
  "has_more": true
}

Returns a list of file requests owned by this user. For apps with the app folder permission, this will only return file requests with destinations in the app folder.

Required scope: file_requests.read

Endpoint format: RPC

Authentication: User

Returns a list of file requests owned by this user. For apps with the app folder permission, this will only return file requests with destinations in the app folder. **Required scope:** `file_requests.read` **Endpoint format:** [RPC](https://docs.dropboxapi.com/dropbox-api/docs/technical-reference/request-response-formats#rpc-endpoints) **Authentication:** [User](https://docs.dropboxapi.com/dropbox-api/docs/auth-types#user-authentication)

Authentication

AuthorizationBearer

OAuth 2.0 token issued to a specific user. Use Authorization: Bearer <token>.

Public clients should use the authorization code flow with PKCE (S256).

For background or offline access, send token_access_type=offline during authorization and use the returned refresh token to obtain new access tokens.

You can generate a short-lived access token from the App Console; see Testing with a generated token.

OAuth 2.0 token issued to a specific user. Use `Authorization: Bearer <token>`. Public clients should use the authorization code flow with PKCE (S256). For background or offline access, send `token_access_type=offline` during authorization and use the returned refresh token to obtain new access tokens. You can generate a short-lived access token from the App Console; see [Testing with a generated token](https://docs.dropboxapi.com/dropbox-api/docs/oauth#testing-with-a-generated-token).

Headers

Dropbox-API-Path-RootstringOptional

Scopes path-based operations to a namespace (root). The value is a JSON serialization of the common.PathRoot union: {".tag": "home"}, {".tag": "root", "root": "<namespace_id>"}, or {".tag": "namespace_id", "namespace_id": "<namespace_id>"}. On failure the request returns 422 with a common.PathRootError.

Scopes path-based operations to a namespace (root). The value is a JSON serialization of the `common.PathRoot` union: `{".tag": "home"}`, `{".tag": "root", "root": "<namespace_id>"}`, or `{".tag": "namespace_id", "namespace_id": "<namespace_id>"}`. On failure the request returns 422 with a `common.PathRootError`.

Request

This endpoint expects a nullable object.

limituint64Optional>=0Defaults to 1000

The maximum number of file requests that should be returned per request.

Response headers

X-Dropbox-Request-IdstringOptional

A unique identifier for the request, useful for debugging and support.

Response

Successful response

cursorstring

Pass the cursor into list/continue to obtain additional file requests.

file_requestslist of objects

The file requests owned by this user. Apps with the app folder permission will only see file requests in their app folder.

has_moreboolean

Is true if there are additional file requests that have not been returned yet. An additional call to :route:list/continue` can retrieve them.

Errors

401

Unauthorized Error

403

Forbidden Error

409

Conflict Error

429

Too Many Requests Error

500

Internal Server Error