Dropbox: Get members of multiple files at once

← Sharing operations · Get started

Operation dropbox.sharing_list_file_members_batch

Provider route: POST /2/sharing/list_file_members/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"]["listFileMembersBatch"]>[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.listFileMembersBatch(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.list_file_members_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 Get members of multiple files at once — request body — body

Referenced models: Deletes a group — request body — headers Dropbox-API-Path-Root, Get members of multiple files at once — 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 Get members of multiple files at once — response body — item

Referenced models: Get members of multiple files at once — response body — item

Schemas

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

Get members of multiple files at once — response body — item

Field	Type	Presence	Description and constraints
$	object	Root	Per-file result for list_file_members/batch.
file	string	Required within parent	Minimum length: 1 Pattern: ^(?:((\/|id:).*|nspath:[0-9]+:.*)|ns:[0-9]+(/.*)?)$
result	Model	Required within parent	Expand Get members of multiple files at once — response body — item result

Referenced models: Get members of multiple files at once — response body — item result

Get members of multiple files at once — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Arguments for list_file_members/batch.
files	array	Required within parent	Maximum items: 100
files[]	string	Each item	Minimum length: 1 Pattern: ^(?:((\/|id:).*|nspath:[0-9]+:.*)|ns:[0-9]+(/.*)?)$
limit	integer	Optional	Minimum: 0 Maximum: 3000

Get members of multiple files at once — 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: result
$ (anyOf 1).members	Model	Required within parent	Expand Use to obtain the members who have been invited to a file, both inherited and uninherited members — response body
$ (anyOf 1).member_count	JSON	Required within parent
$ (anyOf 1).member_count (anyOf 1)	integer	Alternative	Minimum: 0
$ (anyOf 1).member_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (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: ^(?!(?:result|access_error)$)

Referenced models: Use to obtain the members who have been invited to a file, both inherited and uninherited members — response body, Get members of multiple files at once — response body — item result tag access error access error

Use to obtain the members who have been invited to a file, both inherited and uninherited members — response body

Field	Type	Presence	Description and constraints
$	object	Root	Shared file user, group, and invitee membership. Used for the results of list_file_members and list_file_members/continue, and used as part of the results for list_file_members/batch.
users	array	Required within parent
users[]	Model	Each item	Expand Use to obtain the members who have been invited to a file, both inherited and uninherited members — response body — users item
groups	array	Required within parent
groups[]	Model	Each item	Expand Returns shared folder membership by its folder ID — response body — groups item
invitees	array	Required within parent
invitees[]	Model	Each item	Expand Returns shared folder membership by its folder ID — response body — invitees item
cursor	JSON	Optional
cursor (anyOf 1)	string	Alternative
cursor (anyOf 2)	null	Alternative

Referenced models: Returns shared folder membership by its folder ID — response body — groups item, Returns shared folder membership by its folder ID — response body — invitees item, Use to obtain the members who have been invited to a file, both inherited and uninherited members — response body — users item

Get members of multiple files at once — response body — item result tag access error access error

Field	Type	Presence	Description and constraints
$	JSON	Root	User could not access this file.
$ (anyOf 1)	string	Alternative	Known values: no_permission, invalid_file, is_folder, inside_public_folder, inside_osx_package
$ (anyOf 2)	object	Alternative
$ (anyOf 2)..tag	string	Required within parent	Must equal: no_permission
$ (anyOf 3)	object	Alternative
$ (anyOf 3)..tag	string	Required within parent	Must equal: invalid_file
$ (anyOf 4)	object	Alternative
$ (anyOf 4)..tag	string	Required within parent	Must equal: is_folder
$ (anyOf 5)	object	Alternative
$ (anyOf 5)..tag	string	Required within parent	Must equal: inside_public_folder
$ (anyOf 6)	object	Alternative
$ (anyOf 6)..tag	string	Required within parent	Must equal: inside_osx_package
$ (anyOf 7)	object	Alternative	A tag this contract version does not list (Dropbox's other).
$ (anyOf 7)..tag	string	Required within parent	Pattern: ^(?!(?:no_permission|invalid_file|is_folder|inside_public_folder|inside_osx_package)$)

Returns shared folder membership by its folder ID — response body — groups item

Field	Type	Presence	Description and constraints
$	object	Root	The information about a group member of the shared content.
access_type	Model	Required within parent	Expand The current user mounts the designated folder — response body — access type
permissions	JSON	Optional
permissions (anyOf 1)	array	Alternative
permissions (anyOf 1)[]	Model	Each item	Expand Returns shared folder membership by its folder ID — response body — users item permissions array item
permissions (anyOf 2)	null	Alternative
initials	JSON	Optional
initials (anyOf 1)	string	Alternative
initials (anyOf 2)	null	Alternative
is_inherited	boolean	Optional
inherited_access_type	JSON	Optional
inherited_access_type (anyOf 1)	Model	Alternative	Expand The current user mounts the designated folder — response body — access type
inherited_access_type (anyOf 2)	null	Alternative
group	Model	Required within parent	Expand Returns shared folder membership by its folder ID — response body — groups item group

Referenced models: The current user mounts the designated folder — response body — access type, Returns shared folder membership by its folder ID — response body — groups item group, Returns shared folder membership by its folder ID — response body — users item permissions array item

Returns shared folder membership by its folder ID — response body — users item permissions array item

Field	Type	Presence	Description and constraints
$	object	Root	Whether the user is allowed to take the action on the associated member.
action	Model	Required within parent	Expand Returns shared folder membership by its folder ID — response body — users item permissions array item action
allow	boolean	Required within parent
reason	JSON	Optional
reason (anyOf 1)	Model	Alternative	Expand Update the viewer info policy of a file — response body — permissions array item reason Possible reasons the user is denied a permission
reason (anyOf 2)	null	Alternative

Referenced models: Returns shared folder membership by its folder ID — response body — users item permissions array item action, Update the viewer info policy of a file — response body — permissions array item reason Possible reasons the user is denied a permission

Policy, approvals and errors

SDK function policy ID: dropbox.sharing_list_file_members_batch. Catalog operation: sharing/list_file_members_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