• Installs:
  • Today: 0
  • This Week: 312
  • This Month: 1248
  • All Time: 10143
Developer:userstefan.skliarov

Dropbox API Package

Access, store and sync files online and across computers.

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

Dropbox

Dropbox Package

Dropbox

  • Domain: Dropbox
  • Credentials: apiKey, apiSecret

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/Dropbox/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

Dropbox.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

Dropbox.revokeAccessToken

Revokes user access tokens

FieldTypeDescription
accessTokenStringAccess token to revoke

Dropbox.getSingleUserAccount

Get information about a user's account.

FieldTypeDescription
accessTokenStringAccess token
userIdStringID of the user

Dropbox.getMe

Get information about a current user's account.

FieldTypeDescription
accessTokenStringAccess token

Dropbox.getUserAccounts

Get information about a users' accounts.

FieldTypeDescription
accessTokenStringAccess token
userIdsListIDs of the users

Dropbox.getMySpaceUsage

Get the space usage information for the current user's account.

FieldTypeDescription
accessTokenStringAccess token

Dropbox.copy

Copy a file or folder to a different location in the user's Dropbox. If the source path is a folder all its contents will be copied.

FieldTypeDescription
accessTokenStringAccess token
fromPathStringPath in the user's Dropbox to be copied
toPathStringPath in the user's Dropbox that is the destination.
allowSharedFolderBooleanIf true, copy will copy contents in shared folder, otherwise RelocationError.cant_copy_shared_folder will be returned if from_path contains shared folder. This field is always true for move. The default for this field is False.
autoRenameBooleanIf there's a conflict, have the Dropbox server try to autorename the file to avoid the conflict. The default for this field is False.

Dropbox.copyBatch

Copy multiple files or folders to different locations at once in the user's Dropbox.

FieldTypeDescription
accessTokenStringAccess token
entriesListList of entries to be copied. Example: [{"from_path":"/123/sample.json", "to_path": "/321/sample.json"}]
allowSharedFolderBooleanIf true, copy will copy contents in shared folder, otherwise RelocationError.cant_copy_shared_folder will be returned if from_path contains shared folder. This field is always true for move. The default for this field is False.
autoRenameBooleanIf there's a conflict, have the Dropbox server try to autorename the file to avoid the conflict. The default for this field is False.

Dropbox.getCopyStatus

Returns the status of an asynchronous job for copyBatch. If success, it returns list of results for each entry.

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

Dropbox.getCopyReference

Get a copy reference to a file or folder.

FieldTypeDescription
accessTokenStringAccess token
pathStringThe path to the file or folder you want to get a copy reference to.

Dropbox.saveCopyReference

Save a copy reference returned by getCopyReference to the user's Dropbox.

FieldTypeDescription
accessTokenStringAccess token
destinationPathStringPath in the user's Dropbox that is the destination.
copyReferenceStringA copy reference returned by getCopyReference.

Dropbox.createFolder

Create a folder at a given path.

FieldTypeDescription
accessTokenStringAccess token
folderPathStringPath in the user's Dropbox to create.
autoRenameBooleanIf there's a conflict, have the Dropbox server try to autorename the folder to avoid the conflict. The default for this field is False.

Dropbox.delete

Deletes a folder or a file at a given path.

FieldTypeDescription
accessTokenStringAccess token
deletePathStringPath in the user's Dropbox to delete.

Dropbox.deleteBatch

Delete multiple files/folders at once.

FieldTypeDescription
accessTokenStringAccess token
deleteEntriesListlist of entries to delete. Exmaple: [{"path":"/125"}, {"path":"/126"}]

Dropbox.getDeleteStatus

Returns the status of an asynchronous job for deleteBatch. If success, it returns list of results for each entry.

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

Dropbox.downloadFile

Download a file from a user's Dropbox.

FieldTypeDescription
accessTokenStringAccess token
filePathStringPath of the file

Dropbox.getMetadata

Returns the metadata for a file or folder.

FieldTypeDescription
accessTokenStringAccess token
pathStringPath of the file or a folder
includeMediaInfoBooleanIf true, FileMetadata.media_info is set for photo and video. The default for this field is False.
includeDeletedBooleanIf true, DeletedMetadata will be returned for deleted file or folder, otherwise LookupError.not_found will be returned. The default for this field is False.
includeHasExplicitSharedMembersBooleanIf true, the results will include a flag for each file indicating whether or not that file has any explicit members. The default for this field is False.

Dropbox.getFilePreview

Get a preview for a file. Currently previews are only generated for the files with the following extensions: .doc, .docx, .docm, .ppt, .pps, .ppsx, .ppsm, .pptx, .pptm, .xls, .xlsx, .xlsm, .rtf.

FieldTypeDescription
accessTokenStringAccess token
filePathStringPath of the file

Dropbox.getFileTemporaryLink

Get a temporary link to stream content of a file. This link will expire in four hours and afterwards you will get 410 Gone. Content-Type of the link is determined automatically by the file's mime type.

FieldTypeDescription
accessTokenStringAccess token
filePathStringPath of the file

Dropbox.getImageThumbnail

This method currently supports files with the following file extensions: jpg, jpeg, png, tiff, tif, gif and bmp. Photos that are larger than 20MB in size won't be converted to a thumbnail.

FieldTypeDescription
accessTokenStringAccess token
imagePathStringPath of the image
formatSelectThe format for the thumbnail image, jpeg (default) or png. For images that are photos, jpeg should be preferred, while png is better for screenshots and digital arts. The default for this union is jpeg.
sizeStringThe size for the thumbnail image. The default for this union is w64h64.

Dropbox.getFolderContents

Starts returning the contents of a folder.

FieldTypeDescription
accessTokenStringAccess token
folderPathStringPath of the file or a folder
recursiveBooleanIf true, the list folder operation will be applied recursively to all subfolders and the response will contain contents of all subfolders. The default for this field is False.
includeMediaInfoBooleanIf true, FileMetadata.media_info is set for photo and video. The default for this field is False.
includeDeletedBooleanIf true, DeletedMetadata will be returned for deleted file or folder, otherwise LookupError.not_found will be returned. The default for this field is False.
includeHasExplicitSharedMembersBooleanIf true, the results will include a flag for each file indicating whether or not that file has any explicit members. The default for this field is False.

Dropbox.paginateFolderContents

Once a cursor has been retrieved from getFolderContents, use this to paginate through all files and retrieve updates to the folder, following the same rules as documented for getFolderContents.

FieldTypeDescription
accessTokenStringAccess token
cursorStringThe cursor returned by your last call to getFolderContents or paginateFolderContents

Dropbox.getLatestCursor

A way to quickly get a cursor for the folder's state.

FieldTypeDescription
accessTokenStringAccess token
folderPathStringPath of the file or a folder
recursiveBooleanIf true, the list folder operation will be applied recursively to all subfolders and the response will contain contents of all subfolders. The default for this field is False.
includeMediaInfoBooleanIf true, FileMetadata.media_info is set for photo and video. The default for this field is False.
includeDeletedBooleanIf true, DeletedMetadata will be returned for deleted file or folder, otherwise LookupError.not_found will be returned. The default for this field is False.
includeHasExplicitSharedMembersBooleanIf true, the results will include a flag for each file indicating whether or not that file has any explicit members. The default for this field is False.

Dropbox.getFileRevisions

Return revisions of a file.

FieldTypeDescription
accessTokenStringAccess token
filePathStringPath of the file
limitNumberThe maximum number of revision entries returned. The default for this field is 10.

Dropbox.move

Move a file or folder to a different location in the user's Dropbox. If the source path is a folder all its contents will be moved.

FieldTypeDescription
accessTokenStringAccess token
fromPathStringPath in the user's Dropbox to be moved
toPathStringPath in the user's Dropbox that is the destination.
autoRenameBooleanIf there's a conflict, have the Dropbox server try to autorename the file to avoid the conflict. The default for this field is False.

Dropbox.moveBatch

Move multiple files or folders to different locations at once in the user's Dropbox.

FieldTypeDescription
accessTokenStringAccess token
entriesListList of entries to be moved. Example: [{"from_path":"/123/sample.json", "to_path": "/321/sample.json"}]
autoRenameBooleanIf there's a conflict, have the Dropbox server try to autorename the file to avoid the conflict. The default for this field is False.

Dropbox.getMoveStatus

Returns the status of an asynchronous job for moveBatch. If success, it returns list of results for each entry.

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

Dropbox.restoreFileToRevision

Restore a file to a specific revision.

FieldTypeDescription
accessTokenStringAccess token
filePathStringPath of the file in the user's Dropbox to restore.
revisionIdStringId of the revision

Dropbox.saveFileURL

Save a specified URL into a file in user's Dropbox. If the given path already exists, the file will be renamed to avoid the conflict (e.g. myfile (1).txt).

FieldTypeDescription
accessTokenStringAccess token
filePathStringPath of the file in the user's Dropbox to restore.
urlStringThe URL to be saved.

Dropbox.getSaveFileURLStatus

Returns the status of an asynchronous job for saveFileURL. If success, it returns list of results for each entry.

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

Dropbox.search

Searches for files and folders.

FieldTypeDescription
accessTokenStringAccess token
searchPathStringThe path in the user's Dropbox to search. Should probably be a folder.
searchQueryStringThe string to search for. The search string is split on spaces into multiple tokens. For file name searching, the last token is used for prefix matching (i.e. "bat c" matches "bat cave" but not "batman car").
startFromNumberThe starting index within the search results (used for paging). The default for this field is 0.
maxResultsNumberThe maximum number of search results to return. The default for this field is 100.
searchModeSelectThe search mode (filename, filename_and_content, or deleted_filename). Note that searching file content is only available for Dropbox Business accounts. The default for this union is filename.

Dropbox.uploadSingleFile

Create a new file with the contents provided in the request.

FieldTypeDescription
accessTokenStringAccess token
filePathStringPath in the user's Dropbox to save the file.
fileFileThe file to upload
uploadModeStringSelects what to do if the file already exists. The default for this union is add.
autoRenameBooleanIf there's a conflict, as determined by mode, have the Dropbox server try to autorename the file to avoid conflict. The default for this field is False.
clientModifiedDatePickerTimestamp(format="%Y-%m-%dT%H:%M:%SZ") The value to store as the client_modified timestamp.
muteBooleanNormally, users are made aware of any file modifications in their Dropbox account via notifications in the client software. If true, this tells the clients that this modification shouldn't result in a user notification. The default for this field is False.

Dropbox.marksDocAsDeleted

Marks the given Paper doc as deleted. This operation is non-destructive and the doc can be revived by the owner.

FieldTypeDescription
accessTokenStringAccess token
documentIdStringId of the document

Dropbox.getDocs

Return the list of all Paper docs according to the argument specifications.

FieldTypeDescription
accessTokenStringAccess token
filterBySelectAllows user to specify how the Paper docs should be filtered. Possible values: docs_accessed(default), docs_created
sortBySelectAllows user to specify how the Paper docs should be sorted. Possible values: accessed(default), modified, created
sortOrderSelectAllows user to specify the sort order of the result. Possible values: ascending(default), descending
limitNumberSize limit per batch. The maximum number of docs that can be retrieved per batch is 1000. Higher value results in invalid arguments error. The default for this field is 1000.

Dropbox.downloadDocAsHTML

Exports and downloads Paper doc either as HTML.

FieldTypeDescription
accessTokenStringAccess token
documentIdStringId of the document

Dropbox.downloadDocAsMarkdown

Exports and downloads Paper doc either as Markdown.

FieldTypeDescription
accessTokenStringAccess token
documentIdStringId of the document

Dropbox.getDocInvitedUsers

Lists the users who are explicitly invited to the Paper folder in which the Paper doc is contained. For private folders all users (including owner) shared on the folder are listed and for team folders all non-team users shared on the folder are returned.

FieldTypeDescription
accessTokenStringAccess token
documentIdStringId of the document
limitNumberSize limit per batch. The maximum number of users that can be retrieved per batch is 1000. Higher value results in invalid arguments error. The default for this field is 1000.

Dropbox.paginateDocInvitedUsers

Once a cursor has been retrieved from getDocInvitedUsers, use this to paginate through all users on the Paper folder.

FieldTypeDescription
accessTokenStringAccess token
documentIdStringId of the document
cursorStringhe cursor obtained from getDocInvitedUsers

Dropbox.getFolderInfo

Retrieves folder information for the given Paper doc.

FieldTypeDescription
accessTokenStringAccess token
documentIdStringId of the document

Dropbox.paginateDocs

Once a cursor has been retrieved from getDocs, use this to paginate through all Paper doc.

FieldTypeDescription
accessTokenStringAccess token
cursorStringThe cursor obtained from getDocs

Dropbox.getDocSharingPolicy

Gets the default sharing policy for the given Paper doc.

FieldTypeDescription
accessTokenStringAccess token
documentIdStringId of the document

Dropbox.setDocSharingPolicy

Sets the default sharing policy for the given Paper doc.

FieldTypeDescription
accessTokenStringAccess token
documentIdStringId of the document
publicSharingPolicySelectThis value applies to the non-team members. Possible values: people_with_link_can_edit, people_with_link_can_view_and_comment, invite_only, disabled
teamSharingPolicySelectThis value applies to the team members. Possible values: people_with_link_can_edit, people_with_link_can_view_and_comment, invite_only

Dropbox.addUsersToDoc

Allows an owner or editor to add users to a Paper doc or change their permissions using their email or Dropbox account id.

FieldTypeDescription
accessTokenStringAccess token
documentIdStringId of the document
membersListListUsers which should be added to the Paper doc. Specify only email or Dropbox account id. Example: [{"member": {".tag": "email","email": "[email protected]"},"permission_level":{".tag":"view_and_comment"}}]
customMessageStringA personal message that will be emailed to each successfully added member.
quietBooleanClients should set this to true if no email shall be sent to added users. The default for this field is False.

Dropbox.getVisitedDocUsers

Lists all users who visited the Paper doc or users with explicit access. This call excludes users who have been removed.

FieldTypeDescription
accessTokenStringAccess token
documentIdStringId of the document
limitNumberSize limit per batch. The maximum number of users that can be retrieved per batch is 1000. Higher value results in invalid arguments error. The default for this field is 1000.
filterBySelectSpecify this attribute if you want to obtain users that have already accessed the Paper doc. Possible values: shared(default), visited

Dropbox.paginateVisitedUsersDoc

Once a cursor has been retrieved from getVisitedDocUsers, use this to paginate through all users on the Paper doc.

FieldTypeDescription
accessTokenStringAccess token
documentIdStringId of the document
cursorStringThe cursor obtained from getVisitedDocUsers

Dropbox.deleteUserFromDoc

Allows an owner or editor to remove users from a Paper doc using their email or Dropbox account id.

FieldTypeDescription
accessTokenStringAccess token
documentIdStringId of the document
memberTagStringIncludes different ways to identify a member of a shared folder. This datatype comes from an imported namespace originally defined in the sharing namespace. The value will be one of the following datatypes. New values may be introduced as our API evolves. Possible values: email, dropbox_id
memberIdentifierStringId of the user or email

Dropbox.deleteDoc

Permanently deletes the given Paper doc. This operation is final as the doc cannot be recovered.

FieldTypeDescription
accessTokenStringAccess token
documentIdStringId of the document

Dropbox.addFileMembers

Adds specified members to a file.

FieldTypeDescription
accessTokenStringAccess token
fileIdStringId of the file
membersListListUsers which should be added to the Paper doc. Specify only email or Dropbox account id. Example: [{".tag": "email","email": "[email protected]"}]
customMessageStringA personal message that will be emailed to each successfully added member.
quietBooleanClients should set this to true if no email shall be sent to added users. The default for this field is False.
addMessageAsCommentBooleanIf the custom message should be added as a comment on the file. The default for this field is False.
accessLevelSelectAccessLevel union object, describing what access level we want to give new members. Possible values: viewer(default), owner, editor, viewer_no_comment.

Dropbox.addFolderMembers

Adds specified members to a folder.

FieldTypeDescription
accessTokenStringAccess token
folderIdStringId of the folder
membersListListUsers which should be added to the Paper doc. Specify only email or Dropbox account id. Example: [{"member" :{".tag": "email","email": "[email protected]"}}]
customMessageStringA personal message that will be emailed to each successfully added member.
quietBooleanClients should set this to true if no email shall be sent to added users. The default for this field is False.

Dropbox.getUserSharedFolders

Return the list of all shared folders the current user has access to.

FieldTypeDescription
accessTokenStringAccess token
limitNumberThe maximum number of results to return per request. The default for this field is 1000.
actionsListStringA list of FolderActions corresponding to FolderPermissions that should appear in the response's SharedFolderMetadata.permissions field describing the actions the authenticated user can perform on the folder.

Dropbox.checkJobStatus

Returns the status of an asynchronous job.

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

Dropbox.createSharedLink

Create a shared link with custom settings.

FieldTypeDescription
accessTokenStringAccess token
linkPathStringThe path to be shared by the shared link
requestedVisibilitySelectThe requested access for this shared link. Possible values: public, team_only

Dropbox.getSharedFileMetadata

Returns shared file metadata.

FieldTypeDescription
accessTokenStringAccess token
fileIdStringThe file to query.
optionsListA list of FileActions corresponding to FilePermissions that should appear in the response's SharedFileMetadata.permissions field describing the actions the authenticated user can perform on the file.

Dropbox.getSharedFileMetadataBatch

Returns shared file metadata.

FieldTypeDescription
accessTokenStringAccess token
fileIdsListFiles to query.
optionsListA list of FileActions corresponding to FilePermissions that should appear in the response's SharedFileMetadata.permissions field describing the actions the authenticated user can perform on the file.

Dropbox.getSingleFolderMetadata

Returns shared folder metadata by its folder ID.

FieldTypeDescription
accessTokenStringAccess token
folderIdStringThe ID for the shared folder.
optionsListA list of FolderActions corresponding to FolderPermissions that should appear in the response's SharedFolderMetadata.permissions field describing the actions the authenticated user can perform on the folder.

Dropbox.getSharedLinkFile

Download the shared link's file from a user's Dropbox.

FieldTypeDescription
accessTokenStringAccess token
linkUrlStringURL of the shared link.
pathStringIf the shared link is to a folder, this parameter can be used to retrieve the metadata for a specific file or sub-folder in this folder. A relative path should be used.
linkPasswordStringIf the shared link has a password, this parameter can be used.

Dropbox.getSharedLinkMetadata

Get the shared link's metadata.

FieldTypeDescription
accessTokenStringAccess token
linkUrlStringURL of the shared link.
pathStringIf the shared link is to a folder, this parameter can be used to retrieve the metadata for a specific file or sub-folder in this folder. A relative path should be used.
linkPasswordStringIf the shared link has a password, this parameter can be used.

Dropbox.getFileInvitedUsers

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

FieldTypeDescription
accessTokenStringAccess token
fileIdStringThe file for which you want to see members.
limitNumberNumber of members to return max per query. Defaults to 100 if no limit is specified. The default for this field is 100.
actionsListThe actions for which to return permissions on a member.
includeInheritedBooleanWhether to include members who only have access from a parent shared folder. The default for this field is True.

Dropbox.getFilesInvitedUsers

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.

FieldTypeDescription
accessTokenStringAccess token
fileIdsListFiles for which you want to see members.
limitNumberNumber of members to return max per query. Defaults to 10 if no limit is specified.

Dropbox.paginateFileInvitedUsers

Once a cursor has been retrieved from getFileInvitedUsers or getFilesInvitedUsers, use this to paginate through all shared file members.

FieldTypeDescription
accessTokenStringAccess token
cursorStringThe cursor returned by your last call

Dropbox.getSharedFolderMembers

Returns shared folder membership by its folder ID.

FieldTypeDescription
accessTokenStringAccess token
folderIdStringThe folder for which you want to see members.
limitNumberNumber of members to return max per query. The default for this field is 1000.
actionsListThe actions for which to return permissions on a member.

Dropbox.paginateSharedFolderMembers

Once a cursor has been retrieved from getSharedFolderMembers, use this to paginate through all shared folder members.

FieldTypeDescription
accessTokenStringAccess token
cursorStringThe cursor returned by your last call

Dropbox.paginateUserSharedFolders

Once a cursor has been retrieved from getUserSharedFolders, use this to paginate through all shared folders.

FieldTypeDescription
accessTokenStringAccess token
cursorStringThe cursor returned by your last call

Dropbox.getUserMountableFolders

Return the list of all shared folders the current user can mount or unmount.

FieldTypeDescription
accessTokenStringAccess token
limitNumberNumber of members to return max per query. The default for this field is 1000.
actionsListA list of FolderActions corresponding to FolderPermissions that should appear in the response's SharedFolderMetadata.permissions field describing the actions the authenticated user can perform on the folder.

Dropbox.paginateUserMountableFolders

Once a cursor has been retrieved from getUserMountableFolders, use this to paginate through all mountable folders.

FieldTypeDescription
accessTokenStringAccess token
cursorStringThe cursor returned by your last call

Dropbox.getUserSharedFiles

Returns a list of all files shared with current user.

FieldTypeDescription
accessTokenStringAccess token
limitNumberNumber of members to return max per query. The default for this field is 100.
actionsListA list of FileActions corresponding to FilePermissions that should appear in the response's SharedFileMetadata.permissions field describing the actions the authenticated user can perform on the file.

Dropbox.paginateUserSharedFiles

Get more results with a cursor from getUserSharedFiles

FieldTypeDescription
accessTokenStringAccess token
cursorStringThe cursor returned by your last call

Dropbox.updateSharedLinkSettings

Create a shared link with custom settings.

FieldTypeDescription
accessTokenStringAccess token
linkUrlStringURL of the shared link to change its settings
requestedVisibilitySelectThe requested access for this shared link. Possible values: public, team_only

Dropbox.relinquishFileMembership

The current user relinquishes their membership in the designated file. Note that the current user may still have inherited access to this file through the parent folder.

FieldTypeDescription
accessTokenStringAccess token
fileIdStringID of the file

Dropbox.relinquishFolderMembership

The current user relinquishes their membership in the designated folder.

FieldTypeDescription
accessTokenStringAccess token
folderIdStringID of the folder
leaveCopyBooleanKeep a copy of the folder's contents upon relinquishing membership. The default for this field is False.

Dropbox.shareFolder

Share a folder with collaborators.

FieldTypeDescription
accessTokenStringAccess token
folderPathStringThe path to the folder to share. If it does not exist, then a new one is created.
memberPolicySelectWho can be a member of this shared folder. Only applicable if the current user is on a team. Possible values: team, anyone
aclUpdatePolicySelectWho can add and remove members of this shared folder. Possible values: owner, editors
sharedLinkPolicySelectThe policy to apply to shared links created for content inside this shared folder. The current user must be on a team to set this policy to SharedLinkPolicy.members. Possible values: anyone, team, members
forceAsyncBooleanWhether to force the share to happen asynchronously. The default for this field is False.
actionsListA list of FolderActions corresponding to FolderPermissions that should appear in the response's SharedFolderMetadata.permissions field describing the actions the authenticated user can perform on the folder.
accessLevelSelectThe access level on the link for this file. Currently, it only accepts 'viewer' and 'viewer_no_comment'.
linkAudienceSelectThe type of audience on the link for this file. Possible values: public, team, members
linkExpiryJSONAn expiry timestamp to set on a link. Possible values: remove_expiry, set_expiry Timestamp(format="%Y-%m-%dT%H:%M:%SZ") Set a new expiry or change an existing expiry.
linkPasswordSelectThe password for the link. Possible values: remove_password, set_password
viewerInfoPolicySelectWho can enable/disable viewer info for this shared folder.Possible values: enabled, disabled

Dropbox.checkShareJobStatus

Returns the status of an asynchronous job for sharing a folder.

FieldTypeDescription
accessTokenStringAccess token
shareJobIdStringID of the share job

Dropbox.unshareFolder

Allows a shared folder owner to unshare the folder.

FieldTypeDescription
accessTokenStringAccess token
folderIdStringID of the folder
leaveCopyBooleanKeep a copy of the folder's contents upon relinquishing membership. The default for this field is False.

Dropbox.unshareFile

Remove all members from this file. Does not remove inherited members.

FieldTypeDescription
accessTokenStringAccess token
fileIdStringID of the file

Dropbox.mountFolder

The current user mounts the designated folder.

FieldTypeDescription
accessTokenStringAccess token
folderIdStringID of the folder

Dropbox.unmountFolder

The current user unmounts the designated folder.

FieldTypeDescription
accessTokenStringAccess token
folderIdStringID of the folder

Dropbox.revokeSharedLink

Revoke a shared link.

FieldTypeDescription
accessTokenStringAccess token
linkUrlStringURL of the shared link.

Dropbox.removeFileMember

Removes a specified member from the file.

FieldTypeDescription
accessTokenStringAccess token
fileIdStringId of the file
memberJSONMember to remove from this file. Note that even if an email is specified, it may result in the removal of a user (not an invitee) if the user's main account corresponds to that email address. Example: {".tag": "email","email": "[email protected]"}

Dropbox.removeFolderMember

Removes a specified member from the folder.

FieldTypeDescription
accessTokenStringAccess token
folderIdStringId of the file
memberJSONMember to remove from this file. Note that even if an email is specified, it may result in the removal of a user (not an invitee) if the user's main account corresponds to that email address. Example: {".tag": "email","email": "[email protected]mple.com"}
leaveCopyBooleanIf true, the removed user will keep their copy of the folder after it's unshared, assuming it was mounted. Otherwise, it will be removed from their Dropbox. Also, this must be set to false when kicking a group.

Dropbox.checkRemoveMemberStatus

Returns the status of an asynchronous job.

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

Dropbox.transferFolderOwnership

Transfer ownership of a shared folder to a member of the shared folder.User must have AccessLevel.owner access to the shared folder to perform a transfer.

FieldTypeDescription
accessTokenStringAccess token
folderIdStringID of the folder
userIdStringID of the user

Dropbox.updateFileMemberAccess

Changes a member's access on a shared file.

FieldTypeDescription
accessTokenStringAccess token
fileIdStringId of the file
memberIdStringDropbox ID of the user
accessLevelSelectDefines the access levels for collaborators. Currently only available: viewer

Dropbox.updateFolderMemberAccess

Changes a member's access on a shared folder.

FieldTypeDescription
accessTokenStringAccess token
folderIdStringId of the folder
memberJSONMember to remove from this file. Note that even if an email is specified, it may result in the removal of a user (not an invitee) if the user's main account corresponds to that email address. Example: {".tag": "email","email": "[email protected]"}
accessLevelSelectDefines the access levels for collaborators. Currently only available: viewer, editor

Dropbox.updateFolderPolicy

Update the sharing policies for a shared folder.

FieldTypeDescription
accessTokenStringAccess token
folderIdStringThe ID of the folder
memberPolicySelectWho can be a member of this shared folder. Only applicable if the current user is on a team. Possible values: team, anyone
aclUpdatePolicySelectWho can add and remove members of this shared folder. Possible values: owner, editors
sharedLinkPolicySelectThe policy to apply to shared links created for content inside this shared folder. The current user must be on a team to set this policy to SharedLinkPolicy.members. Possible values: anyone, team, members
forceAsyncBooleanWhether to force the share to happen asynchronously. The default for this field is False.
actionsListA list of FolderActions corresponding to FolderPermissions that should appear in the response's SharedFolderMetadata.permissions field describing the actions the authenticated user can perform on the folder.
accessLevelSelectThe access level on the link for this file. Currently, it only accepts 'viewer' and 'viewer_no_comment'.
linkAudienceSelectThe type of audience on the link for this file. Possible values: public, team, members
linkExpiryJSONAn expiry timestamp to set on a link. Possible values: remove_expiry, set_expiry Timestamp(format="%Y-%m-%dT%H:%M:%SZ") Set a new expiry or change an existing expiry.
linkPasswordSelectThe password for the link. Possible values: remove_password, set_password
viewerInfoPolicySelectWho can enable/disable viewer info for this shared folder.Possible values: enabled, disabled
x
circle
Dropbox
$ / 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