Dropbox: Returns shared file metadata — sharing get File Metadata Batch

← Sharing operations · Get started

Operation dropbox.sharing_get_file_metadata_batch

Provider route: POST /2/sharing/get_file_metadata/batch. Alter supplies the connection’s credentials and routing.

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["sharing"]["getFileMetadataBatch"]>[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.sharing.getFileMetadataBatch(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from 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.sharing.get_file_metadata_batch(arguments)
        result = await call.wait()
        return result.body_json()

Input

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 shared file metadata — sharing get File Metadata Batch — request body — body

Referenced models: Deletes a group — request body — headers Dropbox-API-Path-Root, Returns shared file metadata — sharing get File Metadata Batch — request body — body

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
$	array	Root
$[]	Model	Each item	Expand Returns shared file metadata — sharing get File Metadata Batch — response body — item

Referenced models: Returns shared file metadata — sharing get File Metadata Batch — response body — item

Schemas

18 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 shared file metadata — sharing get File Metadata Batch — response body — item

Field	Type	Presence	Description and constraints
$	object	Root	Per file results of get_file_metadata/batch.
file	string	Required within parent	Minimum length: 1 Pattern: ^(?:((\/|id:).*|nspath:[0-9]+:.*)|ns:[0-9]+(/.*)?)$
result	Model	Required within parent	Expand Returns shared file metadata — sharing get File Metadata Batch — response body — item result

Referenced models: Returns shared file metadata — sharing get File Metadata Batch — response body — item result

Returns shared file metadata — sharing get File Metadata Batch — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Arguments of get_file_metadata/batch.
files	array	Required within parent	Maximum items: 100
files[]	string	Each item	Minimum length: 1 Pattern: ^(?:((\/|id:).*|nspath:[0-9]+:.*)|ns:[0-9]+(/.*)?)$
actions	JSON	Optional
actions (anyOf 1)	array	Alternative
actions (anyOf 1)[]	Model	Each item	Expand Update the viewer info policy of a file — request body — body actions array item
actions (anyOf 2)	null	Alternative

Referenced models: Update the viewer info policy of a file — request body — body actions array item

Returns shared file metadata — sharing get File Metadata Batch — response body — item result

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	object	Alternative
$ (anyOf 1)..tag	string	Required within parent	Must equal: metadata
$ (anyOf 1).access_type	JSON	Optional
$ (anyOf 1).access_type (anyOf 1)	Model	Alternative	Expand The current user mounts the designated folder — response body — access type
$ (anyOf 1).access_type (anyOf 2)	null	Alternative
$ (anyOf 1).id	string	Required within parent	Minimum length: 4 Pattern: ^(?:id:.+)$
$ (anyOf 1).expected_link_metadata	JSON	Optional
$ (anyOf 1).expected_link_metadata (anyOf 1)	Model	Alternative	Expand Update the viewer info policy of a file — response body — expected link metadata access level, audience options, audience restricting shared folder, current audience, expiry, link permissions, password protected
$ (anyOf 1).expected_link_metadata (anyOf 2)	null	Alternative
$ (anyOf 1).link_metadata	JSON	Optional
$ (anyOf 1).link_metadata (anyOf 1)	Model	Alternative	Expand Update the viewer info policy of a file — response body — link metadata Metadata of a shared link for a file or folder
$ (anyOf 1).link_metadata (anyOf 2)	null	Alternative
$ (anyOf 1).name	string	Required within parent
$ (anyOf 1).owner_display_names	JSON	Optional
$ (anyOf 1).owner_display_names (anyOf 1)	array	Alternative
$ (anyOf 1).owner_display_names (anyOf 1)[]	string	Each item
$ (anyOf 1).owner_display_names (anyOf 2)	null	Alternative
$ (anyOf 1).owner_team	JSON	Optional
$ (anyOf 1).owner_team (anyOf 1)	Model	Alternative	Expand Update the viewer info policy of a file — response body — owner team Information about a team
$ (anyOf 1).owner_team (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).path_display	JSON	Optional
$ (anyOf 1).path_display (anyOf 1)	string	Alternative
$ (anyOf 1).path_display (anyOf 2)	null	Alternative
$ (anyOf 1).path_lower	JSON	Optional
$ (anyOf 1).path_lower (anyOf 1)	string	Alternative
$ (anyOf 1).path_lower (anyOf 2)	null	Alternative
$ (anyOf 1).permissions	JSON	Optional
$ (anyOf 1).permissions (anyOf 1)	array	Alternative
$ (anyOf 1).permissions (anyOf 1)[]	Model	Each item	Expand Update the viewer info policy of a file — response body — permissions array item
$ (anyOf 1).permissions (anyOf 2)	null	Alternative
$ (anyOf 1).policy	Model	Required within parent	Expand Update the viewer info policy of a file — response body — policy
$ (anyOf 1).preview_url	string	Required within parent
$ (anyOf 1).time_invited	JSON	Optional
$ (anyOf 1).time_invited (anyOf 1)	string	Alternative
$ (anyOf 1).time_invited (anyOf 2)	null	Alternative
$ (anyOf 2)	object	Alternative
$ (anyOf 2)..tag	string	Required within parent	Must equal: access_error
$ (anyOf 2).access_error	Model	Required within parent	Expand Get members of multiple files at once — response body — item result tag access error access error
$ (anyOf 3)	object	Alternative	A tag this contract version does not list (Dropbox's other).
$ (anyOf 3)..tag	string	Required within parent	Pattern: ^(?!(?:metadata|access_error)$)

Referenced models: The current user mounts the designated folder — response body — access type, Update the viewer info policy of a file — response body — expected link metadata access level, audience options, audience restricting shared folder, current audience, expiry, link permissions, password protected, Update the viewer info policy of a file — response body — permissions array item, Update the viewer info policy of a file — response body — policy, Update the viewer info policy of a file — response body — link metadata Metadata of a shared link for a file or folder, Get members of multiple files at once — response body — item result tag access error access error, Update the viewer info policy of a file — response body — owner team Information about a team

The current user mounts the designated folder — response body — access type

Field	Type	Presence	Description and constraints
$	JSON	Root	Defines the access levels for collaborators.
$ (anyOf 1)	string	Alternative	Known values: owner, editor, viewer, viewer_no_comment, traverse, no_access
$ (anyOf 2)	object	Alternative
$ (anyOf 2)..tag	string	Required within parent	Must equal: owner
$ (anyOf 3)	object	Alternative
$ (anyOf 3)..tag	string	Required within parent	Must equal: editor
$ (anyOf 4)	object	Alternative
$ (anyOf 4)..tag	string	Required within parent	Must equal: viewer
$ (anyOf 5)	object	Alternative
$ (anyOf 5)..tag	string	Required within parent	Must equal: viewer_no_comment
$ (anyOf 6)	object	Alternative
$ (anyOf 6)..tag	string	Required within parent	Must equal: traverse
$ (anyOf 7)	object	Alternative
$ (anyOf 7)..tag	string	Required within parent	Must equal: no_access
$ (anyOf 8)	object	Alternative	A tag this contract version does not list (Dropbox's other).
$ (anyOf 8)..tag	string	Required within parent	Pattern: ^(?!(?:owner|editor|viewer|viewer_no_comment|traverse|no_access)$)

Update the viewer info policy of a file — response body — owner team Information about a team

Field	Type	Presence	Description and constraints
$	object	Root	Information about a team.
id	string	Required within parent
name	string	Required within parent

Update the viewer info policy of a file — response body — link metadata Metadata of a shared link for a file or folder audience exceptions count, exceptions exceptions item

Field	Type	Presence	Description and constraints
$	object	Root	Information about the content that has a link audience different than that of this folder.
name	string	Required within parent

Policy, approvals and errors

SDK function policy ID: dropbox.sharing_get_file_metadata_batch. Catalog operation: sharing/get_file_metadata_batch. 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: ["sharing.read"]

Official provider source