Docs Users List

Deprecated

POST

https://api.dropboxapi.com/2/paper/docs/users/list

POST

/2/paper/docs/users/list

import requests
url = "https://api.dropboxapi.com/2/paper/docs/users/list"
payload = {
    "doc_id": "uaSvRuxvnkFa12PTkBv5q",
    "filter_by": { ".tag": "shared" },
    "limit": 100
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())

Response headers

HTTP/1.1 200 OK
X-Dropbox-Request-Id: string

{
  "cursor": {
    "value": "zHZvTPBnXilGgm1AmDgVyZ10zf7qb0qznd5sAVQbbIvoteSnWLjUdLU7aR25hb",
    "expiration": "2016-08-07T14:56:15Z"
  },
  "doc_owner": {
    "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc",
    "display_name": "Robert Smith",
    "email": "bob@example.com",
    "same_team": true,
    "team_member_id": "dbmid:abcd1234"
  },
  "has_more": false,
  "invitees": [
    {
      "invitee": {
        ".tag": "email",
        "email": "jessica@example.com"
      },
      "permission_level": {
        ".tag": "edit"
      }
    }
  ],
  "users": [
    {
      "permission_level": {
        ".tag": "view_and_comment"
      },
      "user": {
        "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc",
        "display_name": "Robert Smith",
        "email": "bob@example.com",
        "same_team": true,
        "team_member_id": "dbmid:abcd1234"
      }
    }
  ]
}

Lists all users who visited the Paper doc or users with explicit access. This call excludes users who have been removed. The list is sorted by the date of the visit or the share date. The list will include both users, the explicitly shared ones as well as those who came in using the Paper url link. Note that this endpoint will continue to work for content created by users on the older version of Paper. To check which version of Paper a user is on, use /users/features/get_values. If the paper_as_files feature is enabled, then the user is running the new version of Paper. Refer to the Paper Migration Guide for migration information.

Required scope: sharing.read

Endpoint format: RPC

Authentication: User

This endpoint does not support apps with the app folder permission.

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.

Headers

Request

This endpoint expects an object.

doc_idstringRequired

The Paper doc ID.

filter_byobject or nullOptional

Specify this attribute if you want to obtain users that have already accessed the Paper doc.

Variant:

paper_apiv2.UserOnPaperDocFilter.visitedobjectRequired

all users who have visited the Paper doc.

limitintegerOptional1-1000Defaults to 1000

Size limit per batch. The maximum number of users that can be retrieved per batch is 1000. Higher value results in invalid arguments error.

Response headers

X-Dropbox-Request-IdstringOptional

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

Response

Successful response

cursorobject

Pass the cursor into docs/users/list/continue to paginate through all users. The cursor preserves all properties as specified in the original call to docs/users/list.

doc_ownerobject

The Paper doc owner. This field is populated on every single response.

has_moreboolean

Will be set to True if a subsequent call with the provided cursor to docs/users/list/continue returns immediately with some results. If set to False please allow some delay before making another call to docs/users/list/continue.

inviteeslist of objects

List of email addresses with their respective permission levels that are invited on the Paper doc.

userslist of objects

List of users with their respective permission levels that are invited on the Paper folder.

Errors

401

Unauthorized Error

403

Forbidden Error

409

Conflict Error

429

Too Many Requests Error

500

Internal Server Error