List Shared Links

POST

https://api.dropboxapi.com/2/sharing/list_shared_links

POST

/2/sharing/list_shared_links

import requests
url = "https://api.dropboxapi.com/2/sharing/list_shared_links"
payload = { "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())

Response headers

HTTP/1.1 200 OK
X-Dropbox-Request-Id: string

{
  "has_more": true,
  "links": [
    {
      ".tag": "file",
      "client_modified": "2015-05-12T15:50:38Z",
      "id": "id:a4ayc_80_OEAAAAAAAAAXw",
      "link_permissions": {
        "allow_comments": true,
        "allow_download": true,
        "audience_options": [
          {
            "allowed": true,
            "audience": {
              ".tag": "public"
            }
          },
          {
            "allowed": false,
            "audience": {
              ".tag": "team"
            }
          },
          {
            "allowed": true,
            "audience": {
              ".tag": "no_one"
            }
          }
        ],
        "can_allow_download": true,
        "can_disallow_download": false,
        "can_remove_expiry": false,
        "can_remove_password": true,
        "can_revoke": false,
        "can_set_expiry": false,
        "can_set_password": true,
        "can_use_extended_sharing_controls": false,
        "require_password": false,
        "resolved_visibility": {
          ".tag": "public"
        },
        "revoke_failure_reason": {
          ".tag": "owner_only"
        },
        "team_restricts_comments": true,
        "visibility_policies": [
          {
            "allowed": true,
            "policy": {
              ".tag": "public"
            },
            "resolved_policy": {
              ".tag": "public"
            }
          },
          {
            "allowed": true,
            "policy": {
              ".tag": "password"
            },
            "resolved_policy": {
              ".tag": "password"
            }
          }
        ]
      },
      "name": "Prime_Numbers.txt",
      "path_lower": "/homework/math/prime_numbers.txt",
      "rev": "a1c10ce0dd78",
      "server_modified": "2015-05-12T15:50:38Z",
      "size": 7212,
      "team_member_info": {
        "display_name": "Roger Rabbit",
        "member_id": "dbmid:abcd1234",
        "team_info": {
          "id": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I",
          "name": "Acme, Inc."
        }
      },
      "url": "https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0"
    }
  ],
  "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu"
}

List shared links of this user. If no path is given, returns a list of all shared links for the current user. For members of business teams using team space and member folders, returns all shared links in the team member’s home folder unless the team space ID is specified in the request header. If a non-empty path is given, returns a list of all shared links that allow access to the given path - direct links to the given path and links to parent folders of the given path. Links to parent folders can be suppressed by setting direct_only to true.

Required scope: sharing.read

Endpoint format: RPC

Authentication: User, Dropbox-API-Select-Admin (Whole Team)

Authentication

AuthorizationBearer

OAuth 2.0 token issued to a specific user. Use Authorization: Bearer <token>.

Public clients should use the authorization code flow with PKCE (S256).

For background or offline access, send token_access_type=offline during authorization and use the returned refresh token to obtain new access tokens.

You can generate a short-lived access token from the App Console; see Testing with a generated token.

Headers

Request

This endpoint expects a nullable object.

cursorstring or nullOptional

The cursor returned by your last call to list_shared_links.

direct_onlyboolean or nullOptional

See list_shared_links description.

pathstring or nullOptionalformat: "(/(.|[\r\n])*|id:.*)|(rev:[0-9a-f]{9,})|(ns:[0-9]+(/(.|[\r\n])*)?)"

See list_shared_links description.

Response headers

X-Dropbox-Request-IdstringOptional

A unique identifier for the request, useful for debugging and support.

Response

Successful response

has_moreboolean

Is true if there are additional shared links that have not been returned yet. Pass the cursor into list_shared_links to retrieve them.

linkslist of objects

Shared links applicable to the path argument.

Variant:

sharing_apiv2.SharedLinkMetadata.fileobject

cursorstring or nullOptional

Pass the cursor into list_shared_links to obtain the additional links. Cursor is returned only if no path is given.

Errors

401

Unauthorized Error

403

Forbidden Error

409

Conflict Error

429

Too Many Requests Error

500

Internal Server Error