Dropbox: Return the lock metadata for the given list of paths

← Files operations · Get started

Operation dropbox.files_get_file_lock_batch

Provider route: POST /2/files/get_file_lock_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["files"]["getFileLockBatch"]>[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.getFileLockBatch(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.files.get_file_lock_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 Lock the files at the given paths — request body — body

Referenced models: Deletes a group — request body — headers Dropbox-API-Path-Root, Lock the files at the given paths — 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
$	Model	Root	Expand Lock the files at the given paths — response body

Referenced models: Lock the files at the given paths — response body

Schemas

15 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)$)

Lock the files at the given paths — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
entries	array	Required within parent
entries[]	Model	Each item	Expand Lock the files at the given paths — request body — body entries item

Referenced models: Lock the files at the given paths — request body — body entries item

Lock the files at the given paths — response body

Field	Type	Presence	Description and constraints
$	object	Root
entries	array	Required within parent
entries[]	Model	Each item	Expand Lock the files at the given paths — response body — entries item

Referenced models: Lock the files at the given paths — response body — entries item

Lock the files at the given paths — request body — body entries item

Field	Type	Presence	Description and constraints
$	object	Root
path	string	Required within parent	Pattern: ^(?:(/(.|[\r\n])*)|(ns:[0-9]+(/(.|[\r\n])*)?)|(id:.*))$

Lock the files at the given paths — response body — entries item

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	object	Alternative
$ (anyOf 1)..tag	string	Required within parent	Must equal: success
$ (anyOf 1).metadata	Model	Required within parent	Expand Returns the metadata for a file or folder — response body
$ (anyOf 1).lock	Model	Required within parent	Expand Lock the files at the given paths — response body — entries item tag success lock
$ (anyOf 2)	object	Alternative
$ (anyOf 2)..tag	string	Required within parent	Must equal: failure
$ (anyOf 2).failure	Model	Required within parent	Expand Lock the files at the given paths — response body — entries item tag failure failure

Referenced models: Lock the files at the given paths — response body — entries item tag success lock, Lock the files at the given paths — response body — entries item tag failure failure, Returns the metadata for a file or folder — response body

Lock the files at the given paths — response body — entries item tag success lock

Field	Type	Presence	Description and constraints
$	object	Root
content	Model	Required within parent	Expand Lock the files at the given paths — response body — entries item tag success lock content

Referenced models: Lock the files at the given paths — response body — entries item tag success lock content

Lock the files at the given paths — response body — entries item tag failure failure

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	string	Alternative	Known values: too_many_write_operations, too_many_files, no_write_permission, cannot_be_locked, file_not_shared, internal_error
$ (anyOf 2)	object	Alternative
$ (anyOf 2)..tag	string	Required within parent	Must equal: path_lookup
$ (anyOf 2).path_lookup	Model	Required within parent	Expand Get thumbnails for a list of images — response body — entries item tag failure failure tag path path
$ (anyOf 3)	object	Alternative
$ (anyOf 3)..tag	string	Required within parent	Must equal: too_many_write_operations
$ (anyOf 4)	object	Alternative
$ (anyOf 4)..tag	string	Required within parent	Must equal: too_many_files
$ (anyOf 5)	object	Alternative
$ (anyOf 5)..tag	string	Required within parent	Must equal: no_write_permission
$ (anyOf 6)	object	Alternative
$ (anyOf 6)..tag	string	Required within parent	Must equal: cannot_be_locked
$ (anyOf 7)	object	Alternative
$ (anyOf 7)..tag	string	Required within parent	Must equal: file_not_shared
$ (anyOf 8)	object	Alternative
$ (anyOf 8)..tag	string	Required within parent	Must equal: lock_conflict
$ (anyOf 8).lock	Model	Required within parent	Expand Lock the files at the given paths — response body — entries item tag success lock
$ (anyOf 9)	object	Alternative
$ (anyOf 9)..tag	string	Required within parent	Must equal: internal_error
$ (anyOf 10)	object	Alternative	A tag this contract version does not list (Dropbox's other).
$ (anyOf 10)..tag	string	Required within parent	Pattern: ^(?!(?:path_lookup|too_many_write_operations|too_many_files|no_write_permission|cannot_be_locked|file_not_shared|lock_conflict|internal_error)$)

Referenced models: Lock the files at the given paths — response body — entries item tag success lock, Get thumbnails for a list of images — response body — entries item tag failure failure tag path path

Lock the files at the given paths — response body — entries item tag success lock content

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	string	Alternative	Known values: unlocked
$ (anyOf 2)	object	Alternative
$ (anyOf 2)..tag	string	Required within parent	Must equal: unlocked
$ (anyOf 3)	object	Alternative
$ (anyOf 3)..tag	string	Required within parent	Must equal: single_user
$ (anyOf 3).created	string	Required within parent
$ (anyOf 3).lock_holder_account_id	string	Required within parent	Maximum length: 40 Minimum length: 40
$ (anyOf 3).lock_holder_team_id	JSON	Optional
$ (anyOf 3).lock_holder_team_id (anyOf 1)	string	Alternative
$ (anyOf 3).lock_holder_team_id (anyOf 2)	null	Alternative
$ (anyOf 4)	object	Alternative	A tag this contract version does not list (Dropbox's other).
$ (anyOf 4)..tag	string	Required within parent	Pattern: ^(?!(?:unlocked|single_user)$)

Get thumbnails for a list of images — response body — entries item tag failure failure tag path path

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	string	Alternative	Known values: not_found, not_file, not_folder, restricted_content, unsupported_content_type, locked
$ (anyOf 2)	object	Alternative
$ (anyOf 2)..tag	string	Required within parent	Must equal: malformed_path
$ (anyOf 2).malformed_path	Model	Optional	Expand Check the status of a save url job — response body — tag failed failed tag path path tag malformed path malformed path
$ (anyOf 3)	object	Alternative
$ (anyOf 3)..tag	string	Required within parent	Must equal: not_found
$ (anyOf 4)	object	Alternative
$ (anyOf 4)..tag	string	Required within parent	Must equal: not_file
$ (anyOf 5)	object	Alternative
$ (anyOf 5)..tag	string	Required within parent	Must equal: not_folder
$ (anyOf 6)	object	Alternative
$ (anyOf 6)..tag	string	Required within parent	Must equal: restricted_content
$ (anyOf 7)	object	Alternative
$ (anyOf 7)..tag	string	Required within parent	Must equal: unsupported_content_type
$ (anyOf 8)	object	Alternative
$ (anyOf 8)..tag	string	Required within parent	Must equal: locked
$ (anyOf 9)	object	Alternative	A tag this contract version does not list (Dropbox's other).
$ (anyOf 9)..tag	string	Required within parent	Pattern: ^(?!(?:malformed_path|not_found|not_file|not_folder|restricted_content|unsupported_content_type|locked)$)

Referenced models: Check the status of a save url job — response body — tag failed failed tag path path tag malformed path malformed path

Policy, approvals and errors

SDK function policy ID: dropbox.files_get_file_lock_batch. Catalog operation: files/get_file_lock_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: ["files.content.read"]

Official provider source