Back to DropboxSharing - List File Members - Batch
Get members of multiple files at once. The arguments to this route are more limited, and the limit on query result size per file is more strict. To customize the results more, use the individual file endpoint.
Inherited users and groups are not included in the result, and permissions are not returned for this endpoint.
Input
type: object
properties:
data:
type: object
description: >
Arguments for :route:`list_file_members/batch`.
files: Files for which to return members.
limit: Number of members to return max per query. Defaults to 10 if no
limit is specified.
properties:
files:
type: array
description: Files for which to return members.
items:
type: string
limit:
type: number
description: >-
Number of members to return max per query. Defaults to 10 if no limit
is specified.
title: Data
Output
type: array
items:
type: object
description: |
Per-file result for :route:`list_file_members/batch`.
file: This is the input file identifier, whether an ID or a path.
result: The result for this particular file.
properties:
result:
type: object
description: |
result: The results of the query for this file if it was successful.
access_error: The result of the query for this file if it was an error.
other: None
properties:
access_error:
type: object
description: >
User could not access this file.
no_permission: Current user does not have sufficient privileges to
perform the desired action.
invalid_file: File specified was not found.
is_folder: A folder can't be shared this way. Use folder sharing or
a shared link instead.
inside_public_folder: A file inside a public folder can't be shared
this way. Use a public link instead.
inside_osx_package: A Mac OS X package can't be shared this way. Use
a shared link instead.
other: None
properties:
.tag:
title: Choice of SharingFileAccessError
type: string
enum:
- no_permission
- invalid_file
- is_folder
- inside_public_folder
- inside_osx_package
- other
.tag:
title: Choice of ListFileMembersIndividualResult
type: string
enum:
- result
- access_error
- other
result:
type: object
description: >
members: A list of members on this file.
member_count: The number of members on this file. This does not
include inherited members.
properties:
member_count:
type: number
description: >-
The number of members on this file. This does not include
inherited members.
members:
type: object
description: >
Shared file user, group, and invitee membership.
Used for the results of :route:`list_file_members` and
:route:`list_file_members/continue`, and used as part of the
results for :route:`list_file_members/batch`.
users: The list of user members of the shared file.
groups: The list of group members of the shared file.
invitees: The list of invited members of a file, but have not
logged in and claimed this.
cursor: Present if there are additional shared file members that
have not been returned yet. Pass the cursor into
:route:`list_file_members/continue` to list additional members.
properties:
cursor:
type: string
description: >-
Present if there are additional shared file members that
have not been returned yet. Pass the cursor into
:route:`list_file_members/continue` to list additional
members.
users:
type: array
description: The list of user members of the shared file.
items:
type: object
description: >
The information about a user member of the shared content
with an appended last seen timestamp.
access_type: The access type for this member.
user: The account information for the membership user.
permissions: The permissions that requesting user has on
this member. The set of permissions corresponds to the
MemberActions in the request.
initials: Never set.
is_inherited: True if the member has access from a parent
folder.
time_last_seen: The UTC timestamp of when the user has
last seen the content, if they have.
platform_type: The platform on which the user has last
seen the content, or unknown.
properties:
access_type:
type: object
description: >
Defines the access levels for collaborators.
owner: The collaborator is the owner of the shared
folder. Owners can view and edit the shared folder as
well as set the folder's policies using
:route:`update_folder_policy`.
editor: The collaborator can both view and edit the
shared folder.
viewer: The collaborator can only view the shared
folder.
viewer_no_comment: The collaborator can only view the
shared folder and does not have any access to
comments.
other: None
properties:
.tag:
title: Choice of AccessLevel
type: string
enum:
- owner
- editor
- viewer
- viewer_no_comment
- other
platform_type:
type: object
description: >
Possible platforms on which a user may view content.
web: The content was viewed on the web.
mobile: The content was viewed on a mobile client.
desktop: The content was viewed on a desktop client.
unknown: The content was viewed on an unknown
platform.
other: None
properties:
.tag:
title: Choice of PlatformType
type: string
enum:
- web
- mobile
- desktop
- unknown
- other
user:
type: object
description: >
Basic information about a user. Use
:route:`users.get_account` and
:route:`users.get_account_batch` to obtain more
detailed information.
account_id: The account ID of the user.
email: Email address of user.
display_name: The display name of the user.
same_team: If the user is in the same team as current
user.
team_member_id: The team member ID of the shared
folder member. Only present if :field:`same_team` is
true.
properties:
email:
type: string
description: Email address of user.
team_member_id:
type: string
description: >-
The team member ID of the shared folder member.
Only present if :field:`same_team` is true.
display_name:
type: string
description: The display name of the user.
account_id:
type: string
description: The account ID of the user.
same_team:
type: boolean
description: If the user is in the same team as current user.
time_last_seen:
type: string
description: >-
The UTC timestamp of when the user has last seen the
content, if they have.
is_inherited:
type: boolean
description: True if the member has access from a parent folder.
permissions:
type: array
description: >-
The permissions that requesting user has on this
member. The set of permissions corresponds to the
MemberActions in the request.
items:
type: object
description: >
Whether the user is allowed to take the action on
the associated member.
action: The action that the user may wish to take on
the member.
allow: True if the user is allowed to take the
action.
reason: The reason why the user is denied the
permission. Not present if the action is allowed.
properties:
action:
type: object
description: >
Actions that may be taken on members of a shared
folder.
leave_a_copy: Allow the member to keep a copy of
the folder when removing.
make_editor: Make the member an editor of the
folder.
make_owner: Make the member an owner of the
folder.
make_viewer: Make the member a viewer of the
folder.
make_viewer_no_comment: Make the member a viewer
of the folder without commenting permissions.
remove: Remove the member from the folder.
other: None
properties:
.tag:
title: Choice of MemberAction
type: string
enum:
- leave_a_copy
- make_editor
- make_owner
- make_viewer
- make_viewer_no_comment
- remove
- other
reason:
type: object
description: >
Possible reasons the user is denied a
permission.
user_not_same_team_as_owner: User is not on the
same team as the folder owner.
user_not_allowed_by_owner: User is prohibited by
the owner from taking the action.
target_is_indirect_member: Target is indirectly
a member of the folder, for example by being
part of a group.
target_is_owner: Target is the owner of the
folder.
target_is_self: Target is the user itself.
target_not_active: Target is not an active
member of the team.
folder_is_limited_team_folder: Folder is team
folder for a limited team.
owner_not_on_team: The content owner needs to be
on a Dropbox team to perform this action.
permission_denied: The user does not have
permission to perform this action on the link.
restricted_by_team: The user's team policy
prevents performing this action on the link.
user_account_type: The user's account type does
not support this action.
user_not_on_team: The user needs to be on a
Dropbox team to perform this action.
folder_is_inside_shared_folder: Folder is inside
of another shared folder.
restricted_by_parent_folder: Policy cannot be
changed due to restrictions from parent folder.
insufficient_plan: None
other: None
properties:
insufficient_plan:
type: object
description: >
message: A message to tell the user to
upgrade in order to support expected action.
upsell_url: A URL to send the user to in
order to obtain the account type they need,
e.g. upgrading. Absent if there is no action
the user can take to upgrade.
properties:
message:
type: string
description: >-
A message to tell the user to upgrade in
order to support expected action.
upsell_url:
type: string
description: >-
A URL to send the user to in order to
obtain the account type they need, e.g.
upgrading. Absent if there is no action
the user can take to upgrade.
.tag:
title: Choice of PermissionDeniedReason
type: string
enum:
- user_not_same_team_as_owner
- user_not_allowed_by_owner
- target_is_indirect_member
- target_is_owner
- target_is_self
- target_not_active
- folder_is_limited_team_folder
- owner_not_on_team
- permission_denied
- restricted_by_team
- user_account_type
- user_not_on_team
- folder_is_inside_shared_folder
- restricted_by_parent_folder
- insufficient_plan
- other
allow:
type: boolean
description: True if the user is allowed to take the action.
initials:
type: string
description: Never set.
groups:
type: array
description: The list of group members of the shared file.
items:
type: object
description: >
The information about a group member of the shared
content.
access_type: The access type for this member.
group: The information about the membership group.
permissions: The permissions that requesting user has on
this member. The set of permissions corresponds to the
MemberActions in the request.
initials: Never set.
is_inherited: True if the member has access from a parent
folder.
properties:
initials:
type: string
description: Never set.
permissions:
type: array
description: >-
The permissions that requesting user has on this
member. The set of permissions corresponds to the
MemberActions in the request.
items:
type: object
description: >
Whether the user is allowed to take the action on
the associated member.
action: The action that the user may wish to take on
the member.
allow: True if the user is allowed to take the
action.
reason: The reason why the user is denied the
permission. Not present if the action is allowed.
properties:
action:
type: object
description: >
Actions that may be taken on members of a shared
folder.
leave_a_copy: Allow the member to keep a copy of
the folder when removing.
make_editor: Make the member an editor of the
folder.
make_owner: Make the member an owner of the
folder.
make_viewer: Make the member a viewer of the
folder.
make_viewer_no_comment: Make the member a viewer
of the folder without commenting permissions.
remove: Remove the member from the folder.
other: None
properties:
.tag:
title: Choice of MemberAction
type: string
enum:
- leave_a_copy
- make_editor
- make_owner
- make_viewer
- make_viewer_no_comment
- remove
- other
reason:
type: object
description: >
Possible reasons the user is denied a
permission.
user_not_same_team_as_owner: User is not on the
same team as the folder owner.
user_not_allowed_by_owner: User is prohibited by
the owner from taking the action.
target_is_indirect_member: Target is indirectly
a member of the folder, for example by being
part of a group.
target_is_owner: Target is the owner of the
folder.
target_is_self: Target is the user itself.
target_not_active: Target is not an active
member of the team.
folder_is_limited_team_folder: Folder is team
folder for a limited team.
owner_not_on_team: The content owner needs to be
on a Dropbox team to perform this action.
permission_denied: The user does not have
permission to perform this action on the link.
restricted_by_team: The user's team policy
prevents performing this action on the link.
user_account_type: The user's account type does
not support this action.
user_not_on_team: The user needs to be on a
Dropbox team to perform this action.
folder_is_inside_shared_folder: Folder is inside
of another shared folder.
restricted_by_parent_folder: Policy cannot be
changed due to restrictions from parent folder.
insufficient_plan: None
other: None
properties:
insufficient_plan:
type: object
description: >
message: A message to tell the user to
upgrade in order to support expected action.
upsell_url: A URL to send the user to in
order to obtain the account type they need,
e.g. upgrading. Absent if there is no action
the user can take to upgrade.
properties:
message:
type: string
description: >-
A message to tell the user to upgrade in
order to support expected action.
upsell_url:
type: string
description: >-
A URL to send the user to in order to
obtain the account type they need, e.g.
upgrading. Absent if there is no action
the user can take to upgrade.
.tag:
title: Choice of PermissionDeniedReason
type: string
enum:
- user_not_same_team_as_owner
- user_not_allowed_by_owner
- target_is_indirect_member
- target_is_owner
- target_is_self
- target_not_active
- folder_is_limited_team_folder
- owner_not_on_team
- permission_denied
- restricted_by_team
- user_account_type
- user_not_on_team
- folder_is_inside_shared_folder
- restricted_by_parent_folder
- insufficient_plan
- other
allow:
type: boolean
description: True if the user is allowed to take the action.
group:
type: object
description: >
The information about a group. Groups is a way to
manage a list of users who need same access
permission to the shared folder.
group_name: None
group_id: None
group_management_type: Who is allowed to manage the
group.
group_type: The type of group.
is_member: If the current user is a member of the
group.
is_owner: If the current user is an owner of the
group.
same_team: If the group is owned by the current user's
team.
group_external_id: External ID of group. This is an
arbitrary ID that an admin can attach to a group.
member_count: The number of members in the group.
properties:
group_external_id:
type: string
description: >-
External ID of group. This is an arbitrary ID that
an admin can attach to a group.
is_owner:
type: boolean
description: If the current user is an owner of the group.
member_count:
type: number
description: The number of members in the group.
same_team:
type: boolean
description: If the group is owned by the current user's team.
is_member:
type: boolean
description: If the current user is a member of the group.
group_management_type:
type: object
description: >
The group type determines how a group is managed.
user_managed: A group which is managed by selected
users.
company_managed: A group which is managed by team
admins only.
system_managed: A group which is managed
automatically by Dropbox.
other: None
properties:
.tag:
title: Choice of GroupManagementType
type: string
enum:
- user_managed
- company_managed
- system_managed
- other
group_name:
type: string
group_id:
type: string
group_type:
type: object
description: >
The group type determines how a group is created
and managed.
team: A group to which team members are
automatically added. Applicable to :link:`team
folders https://www.dropbox.com/help/986` only.
user_managed: A group is created and managed by a
user.
other: None
properties:
.tag:
title: Choice of GroupType
type: string
enum:
- team
- user_managed
- other
access_type:
type: object
description: >
Defines the access levels for collaborators.
owner: The collaborator is the owner of the shared
folder. Owners can view and edit the shared folder as
well as set the folder's policies using
:route:`update_folder_policy`.
editor: The collaborator can both view and edit the
shared folder.
viewer: The collaborator can only view the shared
folder.
viewer_no_comment: The collaborator can only view the
shared folder and does not have any access to
comments.
other: None
properties:
.tag:
title: Choice of AccessLevel
type: string
enum:
- owner
- editor
- viewer
- viewer_no_comment
- other
is_inherited:
type: boolean
description: True if the member has access from a parent folder.
invitees:
type: array
description: >-
The list of invited members of a file, but have not logged
in and claimed this.
items:
type: object
description: >
Information about an invited member of a shared content.
access_type: The access type for this member.
invitee: Recipient of the invitation.
permissions: The permissions that requesting user has on
this member. The set of permissions corresponds to the
MemberActions in the request.
initials: Never set.
is_inherited: True if the member has access from a parent
folder.
user: The user this invitation is tied to, if available.
properties:
invitee:
type: object
description: >
Information about the recipient of a shared content
invitation.
email: E-mail address of invited user.
other: None
properties:
.tag:
title: Choice of InviteeInfo
type: string
enum:
- email
- other
email:
type: string
description: E-mail address of invited user.
access_type:
type: object
description: >
Defines the access levels for collaborators.
owner: The collaborator is the owner of the shared
folder. Owners can view and edit the shared folder as
well as set the folder's policies using
:route:`update_folder_policy`.
editor: The collaborator can both view and edit the
shared folder.
viewer: The collaborator can only view the shared
folder.
viewer_no_comment: The collaborator can only view the
shared folder and does not have any access to
comments.
other: None
properties:
.tag:
title: Choice of AccessLevel
type: string
enum:
- owner
- editor
- viewer
- viewer_no_comment
- other
user:
type: object
description: >
Basic information about a user. Use
:route:`users.get_account` and
:route:`users.get_account_batch` to obtain more
detailed information.
account_id: The account ID of the user.
email: Email address of user.
display_name: The display name of the user.
same_team: If the user is in the same team as current
user.
team_member_id: The team member ID of the shared
folder member. Only present if :field:`same_team` is
true.
properties:
email:
type: string
description: Email address of user.
team_member_id:
type: string
description: >-
The team member ID of the shared folder member.
Only present if :field:`same_team` is true.
display_name:
type: string
description: The display name of the user.
account_id:
type: string
description: The account ID of the user.
same_team:
type: boolean
description: If the user is in the same team as current user.
is_inherited:
type: boolean
description: True if the member has access from a parent folder.
initials:
type: string
description: Never set.
permissions:
type: array
description: >-
The permissions that requesting user has on this
member. The set of permissions corresponds to the
MemberActions in the request.
items:
type: object
description: >
Whether the user is allowed to take the action on
the associated member.
action: The action that the user may wish to take on
the member.
allow: True if the user is allowed to take the
action.
reason: The reason why the user is denied the
permission. Not present if the action is allowed.
properties:
action:
type: object
description: >
Actions that may be taken on members of a shared
folder.
leave_a_copy: Allow the member to keep a copy of
the folder when removing.
make_editor: Make the member an editor of the
folder.
make_owner: Make the member an owner of the
folder.
make_viewer: Make the member a viewer of the
folder.
make_viewer_no_comment: Make the member a viewer
of the folder without commenting permissions.
remove: Remove the member from the folder.
other: None
properties:
.tag:
title: Choice of MemberAction
type: string
enum:
- leave_a_copy
- make_editor
- make_owner
- make_viewer
- make_viewer_no_comment
- remove
- other
reason:
type: object
description: >
Possible reasons the user is denied a
permission.
user_not_same_team_as_owner: User is not on the
same team as the folder owner.
user_not_allowed_by_owner: User is prohibited by
the owner from taking the action.
target_is_indirect_member: Target is indirectly
a member of the folder, for example by being
part of a group.
target_is_owner: Target is the owner of the
folder.
target_is_self: Target is the user itself.
target_not_active: Target is not an active
member of the team.
folder_is_limited_team_folder: Folder is team
folder for a limited team.
owner_not_on_team: The content owner needs to be
on a Dropbox team to perform this action.
permission_denied: The user does not have
permission to perform this action on the link.
restricted_by_team: The user's team policy
prevents performing this action on the link.
user_account_type: The user's account type does
not support this action.
user_not_on_team: The user needs to be on a
Dropbox team to perform this action.
folder_is_inside_shared_folder: Folder is inside
of another shared folder.
restricted_by_parent_folder: Policy cannot be
changed due to restrictions from parent folder.
insufficient_plan: None
other: None
properties:
insufficient_plan:
type: object
description: >
message: A message to tell the user to
upgrade in order to support expected action.
upsell_url: A URL to send the user to in
order to obtain the account type they need,
e.g. upgrading. Absent if there is no action
the user can take to upgrade.
properties:
message:
type: string
description: >-
A message to tell the user to upgrade in
order to support expected action.
upsell_url:
type: string
description: >-
A URL to send the user to in order to
obtain the account type they need, e.g.
upgrading. Absent if there is no action
the user can take to upgrade.
.tag:
title: Choice of PermissionDeniedReason
type: string
enum:
- user_not_same_team_as_owner
- user_not_allowed_by_owner
- target_is_indirect_member
- target_is_owner
- target_is_self
- target_not_active
- folder_is_limited_team_folder
- owner_not_on_team
- permission_denied
- restricted_by_team
- user_account_type
- user_not_on_team
- folder_is_inside_shared_folder
- restricted_by_parent_folder
- insufficient_plan
- other
allow:
type: boolean
description: True if the user is allowed to take the action.
file:
type: string
description: This is the input file identifier, whether an ID or a path.