FolderLinks
Returns folder links from a user's account.
Table Specific Information
The following scopes are required to access this view: sharing.readSelect
The driver uses the Dropbox API to process search criteria that refer to the FolderPath column. The driver processes other filters client-side within the driver. For example, the following queries are processed server side.
SELECT * FROM FolderLinks SELECT * FROM FolderLinks WHERE FolderPath='/Test Folder'You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria will be ignored and an unfiltered response will be returned.
Columns
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | True |
A unique identifier for the folder. |
| Url [KEY] | String | False |
URL of the shared link. |
| Name | String | True |
The linked folder name. This never contains a slash. |
| CanRevoke | Boolean | True |
Whether the caller can revoke the shared link. |
| ResolvedVisibilityPermission | String | True |
The current visibility of the link after considering the shared links policies of the the team (in case the link's owner is part of a team) and the shared folder (in case the linked file is part of a shared folder). |
| RevokeFailureReason | String | True |
The failure reason for revoking the link. This field will only be present if the CanRevoke is false. |
| PathLower | String | True |
The lowercased full path in the user's Dropbox. This always starts with a slash. |
| TeamId | String | True |
The team's unique ID. |
| TeamName | String | True |
The name of the team. |
| TeamDisplayName | String | True |
The display name of the user. |
| TeamMemberId | String | True |
ID of user as a member of a team. This field will only be present if the member is in the same team as current user. |
| ContentOwnerId | String | True |
The content owner's team unique ID. |
| ContentOwnerName | String | True |
The content owner's name of the team. |
| FolderPath | String | True |
The folder path used for retrieving subfolders under. Set this in the filter to retreive only folder links for folders under the specified path. |
| RemoveExpiration | Boolean | False |
If set to true, removes the expiration of the shared link. The default for this field is False. |
| RequestedVisibilityPermission | String | False |
The shared link's requested visibility. This can be overridden by the team and shared folder policies. Note that basic users can only set RequestedVisibility.public as the SharedLinkSettings.requested_visibility. The allowed values are public, team_only, password. |
| RequestedAccess | String | False |
Requested access level you want the audience to gain from this link. Note, modifying access level for an existing link is not supported. This field is optional. The allowed values are viewer, editor, max. |
| Expires | Datetime | False |
Expiration time of the shared link. By default the link won't expire. This field is optional. Note that basic users can only set RequestedVisibility.public as the SharedLinkSettings.requested_visibility |
| LinkPassword | String | False |
If requested_visibility is RequestedVisibility.password this is needed to specify the password to access the link. This field is optional. |
| Audience | String | False |
The new audience who can benefit from the access level specified by the link's access level specified in the `link_access_level` field of `LinkPermissions`. The allowed values are public, team, no_one, password. |