List Folder Members

POST

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

POST

/2/sharing/list_folder_members

import requests
url = "https://api.dropboxapi.com/2/sharing/list_folder_members"
payload = {
    "shared_folder_id": "84528192421",
    "actions": [],
    "limit": 10
}
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": [],
      "initials": "JD"
    }
  ],
  "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu"
}

Returns shared folder membership by its folder ID.

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.

shared_folder_idstringRequiredformat: "[-_0-9a-zA-Z:]+"

The ID for the shared folder. When path is provided, the folder ID will be extracted from the path instead.

actionslist of objects or nullOptional

This is a list indicating whether each returned member will include a boolean value MemberPermission.allow that describes whether the current user can perform the MemberAction on the member.

Variant:

sharing_apiv2.MemberAction.leave_a_copyobjectRequired

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

limituintOptional1-1000Defaults to 1000

The maximum number of results that include members, groups and invitees to return per request.

pathstring or nullOptional

Optional path to get inherited members. When omitted, uses shared_folder_id to return direct members. When provided, extracts folder ID from this path and returns users who have access through parent shared folder.

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 folder.

inviteeslist of objects

The list of invitees to the shared folder.

userslist of objects

The list of user members of the shared folder.

cursorstring or nullOptional

Present if there are additional shared folder members that have not been returned yet. Pass the cursor into list_folder_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