Get Folder Metadata

POST

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

POST

/2/sharing/get_folder_metadata

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

{
  "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": []
}

Returns shared folder metadata 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.

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.

Response headers

X-Dropbox-Request-IdstringOptional

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

Response

Successful response

access_typeobject

The current user's access level for this shared folder.

Variant:

sharing_apiv2.AccessLevel.ownerobject

The collaborator is the owner of the shared folder. Owners can view and edit the shared folder as well as set the folder’s policies using update_folder_policy.

is_inside_team_folderboolean

Whether this folder is inside of a team folder.

is_team_folderboolean

Whether this folder is a team folder.

namestring

The name of the this shared folder.

policyobject

Policies governing this shared folder.

preview_urlstring

URL for displaying a web preview of the shared folder.

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

The ID of the shared folder.

time_inviteddatetime

Timestamp indicating when the current user was invited to this shared folder.

access_inheritanceobject or nullOptional

Whether the folder inherits its members from its parent.

Variant:

sharing_apiv2.AccessInheritance.inheritobject

The shared folder inherits its members from the parent folder.

folder_idstring or nullOptionalformat: "id:.+">=4 characters

The ID of the content.

link_metadataobject or nullOptional

The metadata of the shared content link to this shared folder. Absent if there is no link on the folder. This is for an unreleased feature so it may not be returned yet.

owner_display_nameslist of strings or nullOptional

The display names of the users that own the folder. If the folder is part of a team folder, the display names of the team admins are also included. Absent if the owner display names cannot be fetched.

owner_teamobject or nullOptional

The team that owns the folder. This field is not present if the folder is not owned by a team.

parent_folder_namestring or nullOptional

Display name for the parent folder.

parent_shared_folder_idstring or nullOptionalformat: "[-_0-9a-zA-Z:]+"

The ID of the parent shared folder. This field is present only if the folder is contained within another shared folder.

path_displaystring or nullOptional

The full path of this shared folder. Absent for unmounted folders.

path_lowerstring or nullOptional

The lower-cased full path of this shared folder. Absent for unmounted folders.

permissionslist of objects or nullOptional

Actions the current user may perform on the folder and its contents. The set of permissions corresponds to the FolderActions in the request.

Errors

401

Unauthorized Error

403

Forbidden Error

409

Conflict Error

429

Too Many Requests Error

500

Internal Server Error