Dropbox: Returns the metadata for a file or folder
Dropbox files.getMetadata: arguments, response, policy and SDK examples.
← Files operations · Get started
Operation dropbox.files_get_metadata
Provider route: POST /2/files/get_metadata. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/dropbox with npm, or alter-sdk-dropbox with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { DropboxIntegration } from "@alter-ai/dropbox";
async function execute(input: Parameters<DropboxIntegration["files"]["getMetadata"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new DropboxIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.files.getMetadata(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_dropbox import DropboxIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = DropboxIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.files.get_metadata(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
headers | object | Optional | Additional keys: not allowed |
headers.Dropbox-API-Path-Root | Model | Optional | Expand Deletes a group — request body — headers Dropbox-API-Path-Root |
headers.Dropbox-API-Select-User | string | Optional | |
headers.Dropbox-API-Select-Admin | string | Optional | |
body | Model | Required within parent | Expand Returns the metadata for a file or folder — request body — body |
Referenced models: Deletes a group — request body — headers Dropbox-API-Path-Root, Returns the metadata for a file or folder — request body — body
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Returns the metadata for a file or folder — response body |
Referenced models: Returns the metadata for a file or folder — response body
Schemas
Section titled “Schemas”11 more schemas are linked from the tables above, on the schema pages.
Deletes a group — request body — headers Dropbox-API-Path-Root
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | One of: home |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: home |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: root |
$ (anyOf 3).root | string | Required within parent | Pattern: ^(?:[-_0-9a-zA-Z:]+)$ |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: namespace_id |
$ (anyOf 4).namespace_id | string | Required within parent | Pattern: ^(?:[-_0-9a-zA-Z:]+)$ |
$ (anyOf 5) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 5)..tag | string | Required within parent | Pattern: ^(?!(?:home|root|namespace_id)$) |
Returns the metadata for a file or folder — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
path | string | Required within parent | Pattern: ^(?:(/(.|[\r\n])*|id:.*)|(rev:[0-9a-f]{9,})|(ns:[0-9]+(/(.|[\r\n])*)?))$ |
include_media_info | boolean | Optional | |
include_deleted | boolean | Optional | |
include_has_explicit_shared_members | boolean | Optional | |
include_property_groups | JSON | Optional | |
include_property_groups (anyOf 1) | Model | Alternative | Expand Returns the metadata for a file or folder — request body — body include property groups value |
include_property_groups (anyOf 2) | null | Alternative |
Referenced models: Returns the metadata for a file or folder — request body — body include property groups value
Returns the metadata for a file or folder — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Metadata for a file or folder. |
$ (anyOf 1) | object | Alternative | |
$ (anyOf 1)..tag | string | Required within parent | Must equal: file |
$ (anyOf 1).name | string | Required within parent | |
$ (anyOf 1).path_lower | JSON | Optional | |
$ (anyOf 1).path_lower (anyOf 1) | string | Alternative | |
$ (anyOf 1).path_lower (anyOf 2) | null | Alternative | |
$ (anyOf 1).path_display | JSON | Optional | |
$ (anyOf 1).path_display (anyOf 1) | string | Alternative | |
$ (anyOf 1).path_display (anyOf 2) | null | Alternative | |
$ (anyOf 1).parent_shared_folder_id | JSON | Optional | |
$ (anyOf 1).parent_shared_folder_id (anyOf 1) | string | Alternative | Pattern: ^(?:[-_0-9a-zA-Z:]+)$ |
$ (anyOf 1).parent_shared_folder_id (anyOf 2) | null | Alternative | |
$ (anyOf 1).preview_url | JSON | Optional | |
$ (anyOf 1).preview_url (anyOf 1) | string | Alternative | |
$ (anyOf 1).preview_url (anyOf 2) | null | Alternative | |
$ (anyOf 1).id | string | Required within parent | Minimum length: 1 |
$ (anyOf 1).client_modified | string | Required within parent | |
$ (anyOf 1).server_modified | string | Required within parent | |
$ (anyOf 1).rev | string | Required within parent | Minimum length: 9 Pattern: ^(?:[0-9a-f]+)$ |
$ (anyOf 1).size | JSON | Required within parent | |
$ (anyOf 1).size (anyOf 1) | integer | Alternative | Minimum: 0 |
$ (anyOf 1).size (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 1).media_info | JSON | Optional | |
$ (anyOf 1).media_info (anyOf 1) | Model | Alternative | Expand Restore a specific revision of a file to the given path — response body — media info value |
$ (anyOf 1).media_info (anyOf 2) | null | Alternative | |
$ (anyOf 1).symlink_info | JSON | Optional | |
$ (anyOf 1).symlink_info (anyOf 1) | Model | Alternative | Expand Restore a specific revision of a file to the given path — response body — symlink info target |
$ (anyOf 1).symlink_info (anyOf 2) | null | Alternative | |
$ (anyOf 1).sharing_info | JSON | Optional | |
$ (anyOf 1).sharing_info (anyOf 1) | Model | Alternative | Expand Restore a specific revision of a file to the given path — response body — sharing info modified by, parent shared folder id, read only |
$ (anyOf 1).sharing_info (anyOf 2) | null | Alternative | |
$ (anyOf 1).is_downloadable | boolean | Optional | |
$ (anyOf 1).export_info | JSON | Optional | |
$ (anyOf 1).export_info (anyOf 1) | Model | Alternative | Expand Restore a specific revision of a file to the given path — response body — export info Export information for a file |
$ (anyOf 1).export_info (anyOf 2) | null | Alternative | |
$ (anyOf 1).property_groups | JSON | Optional | |
$ (anyOf 1).property_groups (anyOf 1) | array | Alternative | |
$ (anyOf 1).property_groups (anyOf 1)[] | Model | Each item | Expand Add property groups to a Dropbox file — request body — body property groups item |
$ (anyOf 1).property_groups (anyOf 2) | null | Alternative | |
$ (anyOf 1).has_explicit_shared_members | JSON | Optional | |
$ (anyOf 1).has_explicit_shared_members (anyOf 1) | boolean | Alternative | |
$ (anyOf 1).has_explicit_shared_members (anyOf 2) | null | Alternative | |
$ (anyOf 1).content_hash | JSON | Optional | |
$ (anyOf 1).content_hash (anyOf 1) | string | Alternative | Maximum length: 64 Minimum length: 64 |
$ (anyOf 1).content_hash (anyOf 2) | null | Alternative | |
$ (anyOf 1).file_lock_info | JSON | Optional | |
$ (anyOf 1).file_lock_info (anyOf 1) | Model | Alternative | Expand Restore a specific revision of a file to the given path — response body — file lock info created, is lockholder, lockholder account id, lockholder name |
$ (anyOf 1).file_lock_info (anyOf 2) | null | Alternative | |
$ (anyOf 1).is_restorable | JSON | Optional | |
$ (anyOf 1).is_restorable (anyOf 1) | boolean | Alternative | |
$ (anyOf 1).is_restorable (anyOf 2) | null | Alternative | |
$ (anyOf 2) | Model | Alternative | Expand Returns the metadata for a file or folder — response body — tag folder |
$ (anyOf 3) | Model | Alternative | Expand Returns the metadata for a file or folder — response body — tag deleted |
Referenced models: Add property groups to a Dropbox file — request body — body property groups item, Restore a specific revision of a file to the given path — response body — export info Export information for a file, Restore a specific revision of a file to the given path — response body — file lock info created, is lockholder, lockholder account id, lockholder name, Restore a specific revision of a file to the given path — response body — sharing info modified by, parent shared folder id, read only, Restore a specific revision of a file to the given path — response body — symlink info target, Restore a specific revision of a file to the given path — response body — media info value, Returns the metadata for a file or folder — response body — tag deleted, Returns the metadata for a file or folder — response body — tag folder
Returns the metadata for a file or folder — request body — body include property groups value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | object | Alternative | |
$ (anyOf 1)..tag | string | Required within parent | Must equal: filter_some |
$ (anyOf 1).filter_some | array | Required within parent | Minimum items: 1 |
$ (anyOf 1).filter_some[] | string | Each item | Minimum length: 1 Pattern: ^(?:(/|ptid:).*)$ |
$ (anyOf 2) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 2)..tag | string | Required within parent | Pattern: ^(?!(?:filter_some)$) |
Add property groups to a Dropbox file — request body — body property groups item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A subset of the property fields described by the corresponding PropertyGroupTemplate. Properties are always added to a Dropbox file as a PropertyGroup. The possible key names and value types in this group are defined by the corresponding PropertyGroupTemplate. |
template_id | string | Required within parent | Minimum length: 1 Pattern: ^(?:(/|ptid:).*)$ |
fields | array | Required within parent | |
fields[] | Model | Each item | Expand Add property groups to a Dropbox file — request body — body property groups item fields item |
Referenced models: Add property groups to a Dropbox file — request body — body property groups item fields item
Restore a specific revision of a file to the given path — response body — symlink info target
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
target | string | Required within parent |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: dropbox.files_get_metadata. Catalog operation: files/get_metadata. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["files.metadata.read"]