Back to DropboxSharing - Get Shared Links
Returns a list of :type:LinkMetadata
objects for this user, including collection links.
If no path is given, returns a list of all shared links for the current user, including collection links, up to a maximum of 1000 links.
If a non-empty path is given, returns a list of all shared links that allow access to the given path. Collection links are never returned in this case.
Note that the url field in the response is never the shortened URL.
Input
type: object
properties:
data:
type: object
description: |
path: See :route:`get_shared_links` description.
properties:
path:
type: string
description: See :route:`get_shared_links` description.
title: Data
Output
type: object
description: |
links: Shared links applicable to the path argument.
properties:
links:
type: array
description: Shared links applicable to the path argument.
items:
type: object
description: >
Metadata for a shared link. This can be either a
:type:`PathLinkMetadata` or :type:`CollectionLinkMetadata`.
url: URL of the shared link.
visibility: Who can access the link.
expires: Expiration time, if set. By default the link won't expire.
properties:
url:
type: string
description: URL of the shared link.
expires:
type: string
description: Expiration time, if set. By default the link won't expire.
visibility:
type: object
description: >
Who can access a shared link. The most open visibility is
:field:`public`. The default depends on many aspects, such as team
and user preferences and shared folder settings.
public: Anyone who has received the link can access it. No login
required.
team_only: Only members of the same team can access the link. Login
is required.
password: A link-specific password is required to access the link.
Login is not required.
team_and_password: Only members of the same team who have the
link-specific password can access the link.
shared_folder_only: Only members of the shared folder containing the
linked file can access the link. Login is required.
other: None
properties:
.tag:
title: Choice of Visibility
type: string
enum:
- public
- team_only
- password
- team_and_password
- shared_folder_only
- other