List File Members Batch

POST

https://api.dropboxapi.com/2/sharing/list_file_members/batch

POST

/2/sharing/list_file_members/batch

import requests
url = "https://api.dropboxapi.com/2/sharing/list_file_members/batch"
payload = {
    "files": ["id:3kmLmQFnf1AAAAAAAAAAAw", "id:VvTaJu2VZzAAAAAAAAAADQ"],
    "limit": 1000
}
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

[
  {
    "file": "string",
    "result": {
      ".tag": "result",
      "member_count": 3,
      "members": {
        "groups": [
          {
            "access_type": {
              ".tag": "editor"
            },
            "group": {
              "group_id": "g:e2db7665347abcd600000000001a2b3c",
              "group_management_type": {
                ".tag": "user_managed"
              },
              "group_name": "Test group",
              "group_type": {
                ".tag": "user_managed"
              },
              "is_member": false,
              "is_owner": false,
              "member_count": 10,
              "same_team": true
            },
            "initials": "JD",
            "is_inherited": false,
            "permissions": []
          }
        ],
        "invitees": [
          {
            "access_type": {
              ".tag": "viewer"
            },
            "initials": "JD",
            "invitee": {
              ".tag": "email",
              "email": "jessica@example.com"
            },
            "is_inherited": false,
            "permissions": []
          }
        ],
        "users": [
          {
            "access_type": {
              ".tag": "owner"
            },
            "initials": "JD",
            "is_inherited": false,
            "permissions": [],
            "platform_type": {
              ".tag": "unknown"
            },
            "time_last_seen": "2016-01-20T00:00:00Z",
            "user": {
              "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc",
              "display_name": "Robert Smith",
              "email": "bob@example.com",
              "same_team": true,
              "team_member_id": "dbmid:abcd1234"
            }
          }
        ]
      }
    }
  }
]

Get members of multiple files at once. The arguments to this route are more limited, and the limit on query result size per file is more strict. To customize the results more, use the individual file endpoint.

Inherited users and groups are not included in the result, and permissions are not returned for this endpoint.

Required scope: sharing.read

Endpoint format: RPC

Authentication: User, Dropbox-API-Select-Admin (Whole Team)

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.

fileslist of stringsRequired

Files for which to return members.

limituintOptional0-3000Defaults to 1000

Number of members to return max per query. Defaults to 1000 if no limit is specified.

Response headers

X-Dropbox-Request-IdstringOptional

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

Response

Successful response

filestringformat: "((\/|id:).*|nspath:[0-9]+:.*)|ns:[0-9]+(/.*)?">=1 character

This is the input file identifier, whether an ID or a path.

resultobject

The result for this particular file.

Variant:

sharing_apiv2.ListFileMembersIndividualResult.resultobject

The results of the query for this file if it was successful.

Errors

401

Unauthorized Error

403

Forbidden Error

409

Conflict Error

429

Too Many Requests Error

500

Internal Server Error