Get File Metadata Batch

POST

https://api.dropboxapi.com/2/sharing/get_file_metadata/batch

POST

/2/sharing/get_file_metadata/batch

import requests
url = "https://api.dropboxapi.com/2/sharing/get_file_metadata/batch"
payload = {
    "files": ["id:3kmLmQFnf1AAAAAAAAAAAw", "id:VvTaJu2VZzAAAAAAAAAADQ"],
    "actions": []
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())

[
  {
    "file": "string",
    "result": {
      ".tag": "metadata",
      "access_type": {
        ".tag": "viewer"
      },
      "id": "id:3kmLmQFnf1AAAAAAAAAAAw",
      "name": "file.txt",
      "owner_display_names": [
        "Jane Doe"
      ],
      "owner_team": {
        "id": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I",
        "name": "Acme, Inc."
      },
      "path_display": "/dir/file.txt",
      "path_lower": "/dir/file.txt",
      "permissions": [],
      "policy": {
        "acl_update_policy": {
          ".tag": "owner"
        },
        "member_policy": {
          ".tag": "anyone"
        },
        "resolved_member_policy": {
          ".tag": "team"
        },
        "shared_link_policy": {
          ".tag": "anyone"
        }
      },
      "preview_url": "https://www.dropbox.com/scl/fi/fir9vjelf",
      "time_invited": "2016-01-20T00:00:00Z"
    }
  }
]

Returns shared file metadata.

Required scope: sharing.read

Endpoint format: RPC

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

This endpoint does not support apps with the app folder permission.

Returns shared file metadata. **Required scope:** `sharing.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 (Team Admin)](https://docs.dropboxapi.com/dropbox-api/docs/auth-types#admin-authentication-via-dropbox-api-select-admin) 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.

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.

fileslist of stringsRequired

The files to query.

actionslist of objects or nullOptional

A list of FileActions corresponding to FilePermissions that should appear in the response’s SharedFileMetadata.permissions field describing the actions the authenticated user can perform on the file.

Response headers

X-Dropbox-Request-IdstringOptional

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

Response

Successful response

Errors

401

Unauthorized Error

403

Forbidden Error

409

Conflict Error

429

Too Many Requests Error

500

Internal Server Error