List File Members

POST

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

POST

/2/sharing/list_file_members

import requests
url = "https://api.dropboxapi.com/2/sharing/list_file_members"
payload = { "file": "id:3kmLmQFnf1AAAAAAAAAAAw" }
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

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

Use to obtain the members who have been invited to a file, both inherited and uninherited members.

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.

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

The file for which you want to see members.

actionslist of objects or nullOptional

The actions for which to return permissions on a member.

Variant:

sharing_apiv2.MemberAction.leave_a_copyobjectRequired

Allow the member to keep a copy of the folder when removing.

include_inheritedbooleanOptionalDefaults to true

Whether to include members who only have access from a parent shared folder.

limituintOptional1-300Defaults to 100

Number of members to return max per query. Defaults to 100 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

groupslist of objects

The list of group members of the shared file.

inviteeslist of objects

The list of invited members of a file, but have not logged in and claimed this.

userslist of objects

The list of user members of the shared file.

cursorstring or nullOptional

Present if there are additional shared file members that have not been returned yet. Pass the cursor into list_file_members/continue to list additional members.

Errors

401

Unauthorized Error

403

Forbidden Error

409

Conflict Error

429

Too Many Requests Error

500

Internal Server Error