• Installs:
  • Today: 110
  • This Week: 990
  • This Month: 3410
  • All Time: 26656
Developer:userstefan.skliarov

DropboxBusiness API Package

Regulate access and log usage of Dropbox Business account.

List of Endpoints
This is the list of endpoints this API includes. To add of the endpoints to your app, please click on “Connect to endpoint” text.
See All
List of Webhook Events
This is the list of webhook events this API provides. Webhooks allow you to register to certain events and receive real-time data over websockets.
See All
Discussions
See All
Readme

DropboxBusiness

DropboxBusiness Package

DropboxBusiness

How to get credentials:

  1. Go to Dropbox website
  2. Log in or create a new account
  3. Register an app
  4. After creation your app you will see api Secret and api Key

Custom datatypes:

DatatypeDescriptionExample
DatepickerString which includes date and time2016-05-28 00:00:00
MapString which includes latitude and longitude coma separated50.37, 26.56
ListSimple array["123", "sample"]
SelectString with predefined valuessample
ArrayArray of objects[{"Second name":"123","Age":"12","Photo":"sdf","Draft":"sdfsdf"},{"name":"adi","Second name":"bla","Age":"4","Photo":"asfserwe","Draft":"sdfsdf"}]

Setting up the webhook

  1. Go to Dropbox website
  2. Log in or create a new account
  3. Go to app page
  4. Insert the webhook url and press add

You can use our service as webhookUrl: https://webhooks.rapidapi.com/api/message/DropboxBusiness/webhookEvent/{projectName}/{projectKey} * see credentials description above

Webhook credentials

Please use SDK to test this feature.

  1. Go to RapidAPI
  2. Log in or create an account
  3. Go to My apps
  4. Add new project with projectName to get your project Key | Field | Type | Description |------------|------------|---------- | projectName | credentials| Your RapidAPI project name | projectKey | credentials | Your RapidAPI project key

DropboxBusiness.getAccessToken

Generates user access token

FieldTypeDescription
apiKeycredentialsApi key obtained from Dropbox
apiSecretcredentialsApi secret obtained from Dropbox
redirectUriStringRedirect uri set for your app
codeStringCode provided by user

DropboxBusiness.revokeAccessToken

Revokes user access tokens

FieldTypeDescription
accessTokenStringAccess token to revoke

DropboxBusiness.getSingleMemberDevices

List all device sessions of a team's member.

FieldTypeDescription
accessTokenStringAccess token from Dropbox
teamMemberIdStringThe team's member id
includeWebSessionsBooleanWhether to list web sessions of the team's member The default for this field is True.
includeDesktopClientsBooleanWhether to list linked desktop devices of the team's member The default for this field is True.
includeMobileClientsBooleanWhether to list linked mobile devices of the team's member The default for this field is True.

DropboxBusiness.getMembersDevices

List all device sessions of a team's member.

FieldTypeDescription
accessTokenStringAccess token from Dropbox
cursorStringAt the first call to the getMembersDevices the cursor shouldn't be passed. Then, if the result of the call includes a cursor, the following requests should include the received cursors in order to receive the next sub list of team devices
includeWebSessionsBooleanWhether to list web sessions of the team's member The default for this field is True.
includeDesktopClientsBooleanWhether to list linked desktop devices of the team's member The default for this field is True.
includeMobileClientsBooleanWhether to list linked mobile devices of the team's member The default for this field is True.

DropboxBusiness.revokeSingleDeviceWebSession

Revoke a web session of a team's member

FieldTypeDescription
accessTokenStringAccess token from Dropbox
teamMemberIdStringThe unique id of the member owning the device
sessionIdStringThe session id

DropboxBusiness.revokeSingleDeviceMobileSession

Unlink a linked mobile device

FieldTypeDescription
accessTokenStringAccess token from Dropbox
teamMemberIdStringThe unique id of the member owning the device
sessionIdStringThe session id

DropboxBusiness.revokeSingleDeviceDesktopSession

Unlink a linked desktop device

FieldTypeDescription
accessTokenStringAccess token from Dropbox
teamMemberIdStringThe unique id of the member owning the device
sessionIdStringThe session id
deleteOnUnlinkBooleanWhether to delete all files of the account (this is possible only if supported by the desktop client and will be made the next time the client access the account) The default for this field is False.

DropboxBusiness.revokeDevicesSession

Unlink a linked desktop device

FieldTypeDescription
accessTokenStringAccess token from Dropbox
revokeDevicesJSONList of devices. For example: {"web_session" : {"session_id": "123", "team_member_id" : "321"}, "mobile_client" : {"session_id": "123", "team_member_id" : "321"}, "desktop_client" : {"session_id": "123", "team_member_id" : "321", "delete_on_unlink" : true}}

DropboxBusiness.getTeam

Retrieves information about a team.

FieldTypeDescription
accessTokenStringAccess token from Dropbox

DropboxBusiness.createGroup

Creates a new, empty group, with a requested name.

FieldTypeDescription
accessTokenStringAccess token from Dropbox
groupNameStringGroup name.
groupExternalIdStringThe creator of a team can associate an arbitrary external ID to the group.
groupManagementTypeSelectWhether the team can be managed by selected users, or only by team admins. Possible values: user_managed, company_managed, system_managed.

DropboxBusiness.deleteGroup

Deletes a group. The group is deleted immediately. However the revoking of group-owned resources may take additional time.

FieldTypeDescription
accessTokenStringAccess token from Dropbox
groupIdStringExternal ID of the group.

DropboxBusiness.getSingleGroup

Retrieves information about one group

FieldTypeDescription
accessTokenStringAccess token from Dropbox
groupIdStringExternal ID of the group.

DropboxBusiness.getGroups

Retrieves information about several groups

FieldTypeDescription
accessTokenStringAccess token from Dropbox
groupIdsListExternal IDs of groups.

DropboxBusiness.getGroupJobStatus

Retrieves information about status of any of group job

FieldTypeDescription
accessTokenStringAccess token from Dropbox
groupJobIdStringId of the asynchronous job. This is the value of a response returned from the method that launched the job

DropboxBusiness.getTeamGroups

Lists groups on a team.

FieldTypeDescription
accessTokenStringAccess token from Dropbox
limitNumberNumber of results to return per call. The default for this field is 1000.

DropboxBusiness.paginateTeamGroups

Use this to paginate through all groups.

FieldTypeDescription
accessTokenStringAccess token from Dropbox
cursorStringIndicates from what point to get the next set of groups.

DropboxBusiness.addGroupMember

Adds member to a group.

FieldTypeDescription
accessTokenStringAccess token from Dropbox
groupIdStringExternal ID of the group.
memberIdTypeSelectType of user id. Possible values: team_member_id, external_id, email.
memberIdStringId of the user.
accessTypeSelectAccess type. Possible values: member, owner.

DropboxBusiness.getGroupMembers

Lists members of a group.

FieldTypeDescription
accessTokenStringAccess token from Dropbox
groupIdStringExternal ID of the group.
limitNumberNumber of results to return per call. The default for this field is 1000.

DropboxBusiness.paginateGroupMembers

Use this to paginate through all members of the group.

FieldTypeDescription
accessTokenStringAccess token from Dropbox
cursorStringIndicates from what point to get the next set of groups.

DropboxBusiness.removeGroupMembers

Removes members from a group..

FieldTypeDescription
accessTokenStringAccess token from Dropbox
groupIdStringExternal ID of the group.
usersListList of users to be removed from the group. Example [{".tag" : "email", "email" : "[email protected]" }]
returnMembersBooleanWhether to return the list of members in the group. Note that the default value will cause all the group members to be returned in the response. This may take a long time for large groups. The default for this field is True.

DropboxBusiness.setGroupMemberAccessType

Sets a member's access type in a group.

FieldTypeDescription
accessTokenStringAccess token from Dropbox
groupIdStringExternal ID of the group.
memberIdTypeSelectType of user id. Possible values: team_member_id, external_id, email.
memberIdStringId of the user.
accessTypeSelectAccess type. Possible values: member, owner.
returnMembersBooleanWhether to return the list of members in the group. Note that the default value will cause all the group members to be returned in the response. This may take a long time for large groups. The default for this field is True.

DropboxBusiness.updateSingleGroup

Updates a group's name and/or external ID.

FieldTypeDescription
accessTokenStringAccess token from Dropbox
groupIdStringExternal ID of the group.
newGroupNameStringNew group name.
newGroupExternalIdStringNew arbitrary external ID to the group.
newGroupManagementTypeSelectWhether the team can be managed by selected users, or only by team admins. Possible values: user_managed, company_managed, system_managed.
returnMembersBooleanWhether to return the list of members in the group. Note that the default value will cause all the group members to be returned in the response. This may take a long time for large groups. The default for this field is True.

DropboxBusiness.getSingleMemberLinkedApps

List all linked applications of the team member.

FieldTypeDescription
accessTokenStringAccess token from Dropbox
teamMemberIdStringThe team member id

DropboxBusiness.getMembersLinkedApps

List all applications linked to the team members' accounts.

FieldTypeDescription
accessTokenStringAccess token from Dropbox
cursorsStringIf the result of the call includes a cursor, the following requests should include the received cursors in order to receive the next sub list of the team applications

DropboxBusiness.revokeSingleLinkedApp

Revoke a linked application of the team member

FieldTypeDescription
accessTokenStringAccess token from Dropbox
teamMemberIdStringThe team member id
appIdStringThe application id
keepAppFolderBooleanWhether to keep the application dedicated folder (in case the application uses one) The default for this field is True.

DropboxBusiness.revokeLinkedApps

Revoke linked applications of the team members

FieldTypeDescription
accessTokenStringAccess token from Dropbox
revokeLinkedAppArrayList of linked apps

DropboxBusiness.addTeamMember

Adds members to a team.

FieldTypeDescription
accessTokenStringAccess token from Dropbox
memberEmailStringMember's email
memberGivenNameStringMember's first name.
memberSurnameStringMember's last name.
memberExternalIdStringExternal ID for member.
memberPersistentIdStringPersistent ID for member. This field is only available to teams using persistent ID SAML configuration.
sendWelcomeEmailBooleanWhether to send a welcome email to the member. If send_welcome_email is false, no email invitation will be sent to the user. This may be useful for apps using single sign-on (SSO) flows for onboarding that want to handle announcements themselves. The default for this field is True.
memberRoleSelectDescribes which team-related admin permissions a user has. Possible values: member_only(default), support_admin, user_management_admin, team_admin
forceAsyncBooleanWhether to force the add to happen asynchronously. The default for this field is False.

DropboxBusiness.checkAddTeamMemberStatus

Use this to poll the status of the asynchronous request of addTeamMember.

FieldTypeDescription
accessTokenStringAccess token from Dropbox
addMemberJobIdStringId of the asynchronous job.

DropboxBusiness.getTeamMembers

Lists members of a team.

FieldTypeDescription
accessTokenStringAccess token from Dropbox
limitNumberNumber of results to return per call. The default for this field is 1000.
includeRemovedBooleanWhether to return removed members. The default for this field is False.

DropboxBusiness.getTeamMembersInfo

Returns information about multiple team members.

FieldTypeDescription
accessTokenStringAccess token from Dropbox
membersListExample: [{".tag": "team_member_id","team_member_id": "dbmid:efgh5678"}]

DropboxBusiness.getSingleTeamMemberInfo

Returns information about single team member.

FieldTypeDescription
accessTokenStringAccess token from Dropbox
memberIdTypeSelectArgument for selecting a single user, either by team_member_id, external_id or email.
memberIdStringId of the user.

DropboxBusiness.paginateTeamMembers

Use this to paginate through all team members.

FieldTypeDescription
accessTokenStringAccess token from Dropbox
cursorStringIndicates from what point to get the next set of members.

DropboxBusiness.recoverDeletedMember

Recover a deleted member.

FieldTypeDescription
accessTokenStringAccess token from Dropbox
memberIdTypeSelectArgument for selecting a single user, either by team_member_id, external_id or email.
memberIdStringId of the user.

DropboxBusiness.removeTeamMember

Removes a member from a team.

FieldTypeDescription
accessTokenStringAccess token from Dropbox
memberIdTypeSelectArgument for selecting a single user, either by team_member_id, external_id or email.
memberIdStringId of the user.
destinationMemberIdTypeSelectArgument for selecting a single user, either by team_member_id, external_id or email.
destinationMemberIdStringIf provided, files from the deleted member account will be transferred to this user.
adminMemberIdTypeSelectArgument for selecting a single user, either by team_member_id, external_id or email.
adminMemberIdStringIf provided, errors during the transfer process will be sent via email to this user. If the destinationMemberId argument was provided, then this argument must be provided as well.
wipeDataBooleanIf provided, controls if the user's data will be deleted on their linked devices. The default for this field is True.
keepAccountBooleanDowngrade the member to a Basic account. The user will retain the email address associated with their Dropbox account and data in their account that is not restricted to team members. In order to keep the account the argument wipeData should be set to False. The default for this field is False.

DropboxBusiness.checkRemoveTeamMemberStatus

Use this to poll the status of the asynchronous request.

FieldTypeDescription
accessTokenStringAccess token from Dropbox
removeTeamMemberJobIdStringId of the asynchronous job.

DropboxBusiness.sendWelcomeEmail

Sends welcome email to pending team member.

FieldTypeDescription
accessTokenStringAccess token from Dropbox
memberIdTypeSelectArgument for selecting a single user, either by team_member_id, external_id or email.
memberIdStringId of the user.

DropboxBusiness.updateTeamMemberPermissions

Updates a team member's permissions.

FieldTypeDescription
accessTokenStringAccess token from Dropbox
memberIdTypeSelectArgument for selecting a single user, either by team_member_id, external_id or email.
memberIdStringId of the user.
newRoleSelectDescribes which team-related admin permissions a user has. Possible values: team_admin, user_management_admin, support_admin, member_only

DropboxBusiness.updateTeamMemberProfile

Updates a team member's profile.

FieldTypeDescription
accessTokenStringAccess token from Dropbox
memberIdTypeSelectArgument for selecting a single user, either by team_member_id, external_id or email.
memberIdStringID of the member
memberEmailStringMember's email
memberGivenNameStringMember's first name.
memberSurnameStringMember's last name.
memberExternalIdStringExternal ID for member.
memberPersistentIdStringPersistent ID for member. This field is only available to teams using persistent ID SAML configuration.

DropboxBusiness.suspendMemberFromTeam

Suspend a member from a team.

FieldTypeDescription
accessTokenStringAccess token from Dropbox
memberIdTypeSelectArgument for selecting a single user, either by team_member_id, external_id or email.
memberIdStringID of the member
wipeDataBooleanIf provided, controls if the user's data will be deleted on their linked devices. The default for this field is True.

DropboxBusiness.unsuspendMemberFromTeam

Unsuspend a member from a team.

FieldTypeDescription
accessTokenStringAccess token from Dropbox
memberIdTypeSelectArgument for selecting a single user, either by team_member_id, external_id or email.
memberIdStringID of the member

DropboxBusiness.getTeamUsersActivityReport

Retrieves reporting data about a team's user activity.

FieldTypeDescription
accessTokenStringAccess token from Dropbox
startDateDatePickerTimestamp(format="%Y-%m-%d")? Optional starting date (inclusive)
endDateDatePickerTimestamp(format="%Y-%m-%d")? Optional ending date (exclusive)

DropboxBusiness.getTeamLinkedDevicesReport

Retrieves reporting data about a team's linked devices.

FieldTypeDescription
accessTokenStringAccess token from Dropbox
startDateDatePickerTimestamp(format="%Y-%m-%d")? Optional starting date (inclusive)
endDateDatePickerTimestamp(format="%Y-%m-%d")? Optional ending date (exclusive)

DropboxBusiness.getTeamMembershipReport

Retrieves reporting data about a team's membership.

FieldTypeDescription
accessTokenStringAccess token from Dropbox
startDateDatePickerTimestamp(format="%Y-%m-%d")? Optional starting date (inclusive)
endDateDatePickerTimestamp(format="%Y-%m-%d")? Optional ending date (exclusive)

DropboxBusiness.getTeamStorageUsageReport

Retrieves reporting data about a team's storage usage.

FieldTypeDescription
accessTokenStringAccess token from Dropbox
startDateDatePickerTimestamp(format="%Y-%m-%d")? Optional starting date (inclusive)
endDateDatePickerTimestamp(format="%Y-%m-%d")? Optional ending date (exclusive)

DropboxBusiness.setActiveArchivedFolder

Sets an archived team folder's status to active.

FieldTypeDescription
accessTokenStringAccess token from Dropbox
teamFolderIdStringThe ID of the team folder.

DropboxBusiness.archiveTeamFolder

Sets an active team folder's status to archived and removes all folder and file members.

FieldTypeDescription
accessTokenStringAccess token from Dropbox
teamFolderIdStringThe ID of the team folder.
forceAsyncOffBooleanWhether to force the archive to happen synchronously. The default for this field is False.

DropboxBusiness.checkArchiveFolderStatus

Returns the status of an asynchronous job for archiving a team folder.

FieldTypeDescription
accessTokenStringAccess token from Dropbox
archiveJobIdStringId of the asynchronous job.

DropboxBusiness.createTeamFolder

Creates a new, active, team folder.

FieldTypeDescription
accessTokenStringAccess token from Dropbox
folderNameStringName of the folder

DropboxBusiness.getTeamFoldersMetadata

Retrieves metadata for team folders.

FieldTypeDescription
accessTokenStringAccess token from Dropbox
teamFolderIdsListThe list of team folder IDs.

DropboxBusiness.getTeamFolders

Lists all team folders.

FieldTypeDescription
accessTokenStringAccess token from Dropbox
limitNumberThe maximum number of results to return per request. The default for this field is 1000.

DropboxBusiness.deleteArchivedFolder

Permanently deletes an archived team folder.

FieldTypeDescription
accessTokenStringAccess token from Dropbox
teamFolderIdStringThe ID of the team folder.

DropboxBusiness.renameTeamFolder

Changes an active team folder's name.

FieldTypeDescription
accessTokenStringAccess token from Dropbox
teamFolderIdStringThe ID of the team folder.
teamFolderNameStringThe new name of the team folder.

DropboxBusiness.getAuthenticatedAdmin

Returns the member profile of the admin who generated the team access token used to make the call.

FieldTypeDescription
accessTokenStringAccess token from Dropbox

DropboxBusiness.permanentlyDelete

Permanently delete the file or folder at a given path

FieldTypeDescription
accessTokenStringAccess token from Dropbox
pathStringPath in the user's Dropbox to delete.
x
circle
DropboxBusiness
$ / m
We will charge your card every month for the plan amount, as well as any overages incurred in the previous month.
?

Oops, we are missing some details

Looks like there are a few missing details that you haven't filled in yet.
These details are important and will help us protect you and let you know about anything new.

x

Connect your app to APIs via RapidAPI

Consume and monitor multiple APIs through the RapidAPI SDK.
Click start to set up your app and connect to your first API.

START

Give your app a name

This app will be used in RapidAPI to collect and connect all the APIs you need.

NEXT

Connect your project

Choose your backend language and then install & require the RapidAPI SDK.

  • node
    NodeJS
  • php
    PHP
  • python
    Python
  • objc
    Obj-C
  • android
    Android
  • go
    GO
  • ruby
    Ruby
  • csharp
    C#

Install SDK

Run the following command to install the SDK:

npm install rapidapi-connect --save

Require SDK

In your code, add the following code to require the RapidAPI SDK:

NEXT

Hooray! You are connected

Use the following code to try it out by getting all the APIs that are on RapidAPI.

rapid.call('RapidAPI', 'getAll', {'{}'});
FINISH
esccloses this view
x

Login to RapidAPI

Create endpoints based on popular APIs and share with others.
Follow popular APIs and get updated. Stand out in the community of developers.

LOG INSIGN UP
Login with Github
Login with Facebook
Login with Google
Or
Remember Me

  • We're not going to post anything on your wall.
  • We're not planning to spam you.
  • esccloses this view
    x

    Why sign up to RapidAPI?

    • integrate
      Integrate APIs into your app
      Ruby, Java, Elixir, Node.js, Phyton, Objective C, Swift, PHP and MORE
    • keys
      Save all API keys in one place
    • notifications
      Get notifications about API changes
    • stats
      Get stats and monitor API connections
    Sign up with Github
    Sign up with Facebook
    Sign up with Google
  • We're not going to post anything on your wall.
  • We're not planning to spam you.
  • esccloses this view
    x

    Authentication

    Authenticate
    esccloses this view