List Folders

POST

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

POST

/2/sharing/list_folders

import requests
url = "https://api.dropboxapi.com/2/sharing/list_folders"
payload = {
    "actions": [],
    "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

{
  "entries": [
    {
      "access_type": {
        ".tag": "owner"
      },
      "is_inside_team_folder": false,
      "is_team_folder": false,
      "name": "dir",
      "policy": {
        "acl_update_policy": {
          ".tag": "owner"
        },
        "shared_link_policy": {
          ".tag": "anyone"
        },
        "member_policy": {
          ".tag": "anyone"
        },
        "resolved_member_policy": {
          ".tag": "team"
        }
      },
      "preview_url": "https://www.dropbox.com/scl/fo/fir9vjelf",
      "shared_folder_id": "84528192421",
      "time_invited": "2016-01-20T00:00:00Z",
      "access_inheritance": {
        ".tag": "inherit"
      },
      "folder_id": "id:a4ayc_80_OEAAAAAAAAAXw",
      "link_metadata": {
        "audience_options": [
          {
            ".tag": "public"
          },
          {
            ".tag": "team"
          },
          {
            ".tag": "members"
          }
        ],
        "current_audience": {
          ".tag": "public"
        },
        "link_permissions": [
          {
            "action": {
              ".tag": "change_audience"
            },
            "allow": true
          }
        ],
        "password_protected": false,
        "url": ""
      },
      "owner_display_names": [
        "Jane Doe"
      ],
      "owner_team": {
        "id": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I",
        "name": "Acme, Inc."
      },
      "parent_folder_name": "Parent Shared Folder",
      "path_lower": "/dir",
      "permissions": []
    }
  ],
  "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu"
}

Return the list of all shared folders the current user has access to.

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 a nullable object.

actionslist of objects or nullOptional

A list of FolderActions corresponding to FolderPermissions that should appear in the response’s SharedFolderMetadata.permissions field describing the actions the authenticated user can perform on the folder.

Variant:

sharing_apiv2.FolderAction.change_optionsobjectRequired

Change folder options, such as who can be invited to join the folder.

limituintOptional1-1000Defaults to 1000

The maximum number of results to return per request.

Response headers

X-Dropbox-Request-IdstringOptional

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

Response

Successful response

entrieslist of objects

List of all shared folders the authenticated user has access to.

cursorstring or nullOptional

Present if there are additional shared folders that have not been returned yet. Pass the cursor into the corresponding continue endpoint (either list_folders/continue or list_mountable_folders/continue) to list additional folders.

Errors

401

Unauthorized Error

403

Forbidden Error

409

Conflict Error

429

Too Many Requests Error

500

Internal Server Error