Get Metadata

POST

https://api.dropboxapi.com/2/files/get_metadata

POST

/2/files/get_metadata

import requests
url = "https://api.dropboxapi.com/2/files/get_metadata"
payload = { "path": "/Homework/math" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())

{
  ".tag": "file",
  "client_modified": "2015-05-12T15:50:38Z",
  "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
  "file_lock_info": {
    "created": "2015-05-12T15:50:38Z",
    "is_lockholder": true,
    "lockholder_name": "Imaginary User"
  },
  "has_explicit_shared_members": false,
  "id": "id:a4ayc_80_OEAAAAAAAAAXw",
  "is_downloadable": true,
  "name": "Prime_Numbers.txt",
  "path_display": "/Homework/math/Prime_Numbers.txt",
  "path_lower": "/homework/math/prime_numbers.txt",
  "property_groups": [
    {
      "fields": [
        {
          "name": "Security Policy",
          "value": "Confidential"
        }
      ],
      "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa"
    }
  ],
  "rev": "a1c10ce0dd78",
  "server_modified": "2015-05-12T15:50:38Z",
  "sharing_info": {
    "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc",
    "parent_shared_folder_id": "84528192421",
    "read_only": true
  },
  "size": 7212
}

Returns the metadata for a file or folder. Note: Metadata for the root folder is unsupported.

Required scope: files.metadata.read

Endpoint format: RPC

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

Returns the metadata for a file or folder. Note: Metadata for the root folder is unsupported. **Required scope:** `files.metadata.read` **Endpoint format:** [RPC](https://docs.dropboxapi.com/dropbox-api/docs/technical-reference/request-response-formats#rpc-endpoints) **Authentication:** [User](https://docs.dropboxapi.com/dropbox-api/docs/auth-types#user-authentication), [Dropbox-API-Select-Admin (Whole Team)](https://docs.dropboxapi.com/dropbox-api/docs/auth-types#admin-authentication-via-dropbox-api-select-admin)

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.

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](https://docs.dropboxapi.com/dropbox-api/docs/oauth#testing-with-a-generated-token).

Headers

Dropbox-API-Path-RootstringOptional

Scopes path-based operations to a namespace (root). The value is a JSON serialization of the common.PathRoot union: {".tag": "home"}, {".tag": "root", "root": "<namespace_id>"}, or {".tag": "namespace_id", "namespace_id": "<namespace_id>"}. On failure the request returns 422 with a common.PathRootError.

Scopes path-based operations to a namespace (root). The value is a JSON serialization of the `common.PathRoot` union: `{".tag": "home"}`, `{".tag": "root", "root": "<namespace_id>"}`, or `{".tag": "namespace_id", "namespace_id": "<namespace_id>"}`. On failure the request returns 422 with a `common.PathRootError`.

Request

This endpoint expects an object.

pathstringRequiredformat: "(/(.|[\r\n])*|id:.*)|(rev:[0-9a-f]{9,})|(ns:[0-9]+(/(.|[\r\n])*)?)"

The path of a file or folder on Dropbox.

include_deletedbooleanOptionalDefaults to false

If true, DeletedMetadata will be returned for deleted file or folder, otherwise LookupError.not_found will be returned.

include_has_explicit_shared_membersbooleanOptionalDefaults to false

If true, the results will include a flag for each file indicating whether or not that file has any explicit members.

include_media_infobooleanOptionalDefaults to false

If true, FileMetadata.media_info is set for photo and video.

include_property_groupsobject or nullOptional

If set to a valid list of template IDs, FileMetadata.property_groups is set if there exists property data associated with the file and each of the listed templates.

Response headers

X-Dropbox-Request-IdstringOptional

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

Response

Successful response

Variant:

files.Metadata.fileobject

Errors

401

Unauthorized Error

403

Forbidden Error

409

Conflict Error

429

Too Many Requests Error

500

Internal Server Error