Cloudreve API Docs
  1. User
Cloudreve API Docs
  • Site
    • Ping
      GET
    • Get CAPTCHA
      GET
    • Get site settings
      GET
  • Session
    • Token
      • Password sign-in
      • Finish sign-in with 2FA
      • Refresh Token
      • Sign out
    • OpenID
      • Prepare OpenID sign-in
      • Finish OpenID sign-in
      • Unlink OpenID
    • Passkey
      • Prepare Passkey sign-in
      • Finish Passkey sign-in
    • Prepare login
      GET
  • User
    • Passkey
      • Prepare passkey registration
      • Finish passkey registration
      • Delete passkey
    • Setting
      • List available storage policies
      • List available nodes
      • Get preferences
      • Prepare enabling 2FA
      • Update preference setting
      • Update profile pricture
    • Sign up
      POST
    • Send reset password email
      POST
    • Reset password via temp link
      PATCH
    • Get profile picture
      GET
    • Get user
      GET
    • List user's share links
      GET
    • Get storage capacity
      GET
    • Search user
      GET
    • List credit changes
      GET
    • List payments
      GET
  • Callback
    • Complete OneDrive upload
      GET
    • Complete COS upload
      GET
    • Complete S3 upload
      GET
    • Complete OBS upload
      GET
  • Workflow
    • Remote Download
      • Create remote download
      • Select files to download
      • Cancel task
    • List tasks
      GET
    • Get task progress
      GET
    • Create archive
      POST
    • Extract archive
      POST
    • Relocate storage policy
      POST
    • Import external files
      POST
  • File
    • Permission
      • Set permission
      • Delete permission setting
    • Upload
      • Create upload session
      • Upload file chunk
      • Delete upload session
    • Pin
      • Pin to sidebar
      • Delete a pin
    • Version
      • Set file version
      • Delete file version
    • Direct Link
      • Create direct links
      • Delete direct link
    • List files
    • List file activities
    • Get file info
    • Get thumbnail URL
    • Update file content
    • Create viewer session
    • Create file
    • Rename file
    • Move or copy files
    • Create download URL
    • Restore from trash bin
    • Delete file
    • Force unlock
    • Patch metadata
    • Mount storage policy
    • Update view setting
  • Share
    • Create share link
    • Edit share link
    • Get share link info
    • List my share links
    • Delete share link
  • VAS
    • Payment
      • Create a payment
      • Get payment status
    • GiftCode
      • Check gift code
      • Redeem gift code
  • Group
    • List groups
  • WebDAV
    • List accounts
    • Create account
    • Update account
    • Delete account
  1. User

List user's share links

GET
/user/shares/{user-id}
Auth: None
List public share links created by the given user.

Request

Authorization
Add the parameter
Authorization
to Headers
,whose value is to concatenate the Token after the Bearer.
Example:
Authorization: Bearer ********************
Path Params
user-id
string 
required
ID of the user.
Example:
lpua
Query Params
page_size
integer 
required
Page size.
>= 10<= 100
Example:
10
order_by
enum<string> 
optional
Field name for ordering.
Allowed values:
viewsdownloadspriceremain_downloadsid
Default:
id
order_direction
enum<string> 
optional
Allowed values:
ascdesc
Default:
asc
Example:
asc
next_page_token
string 
optional
Token for requesting next page. Empty value means requesting the first page.

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/user/shares/lpua?page_size=10&order_by&order_direction=asc&next_page_token'

Responses

🟢200Success
application/json
Body
data
object (ListShareResponse) 
required
shares
array[object (Share) {16}] 
required
List of share links.
pagination
object 
required
Pagination propertities.
code
integer 
required
Response code.
0 - Success.
Default:
0
Example:
0
msg
string 
optional
Human readable error message (if any).
error
string  | null 
optional
Internal error message, only visable in debug mode.
correlation_id
string <uuid> | null 
optional
Correlation ID of the request. Only presented on failed reqeust.
Example:
b4351ecc-ee1a-4455-bc94-2c3dbcc58538
Example
{
    "code": 0,
    "data": {
        "shares": [
            {
                "id": "VoMFL",
                "name": "BrNJdjbgi1mvqBf7zycSCskw6ky8nle0",
                "visited": 1,
                "unlocked": true,
                "source_type": 1,
                "owner": {
                    "id": "lpua",
                    "email": "admin@cloudreve.org",
                    "nickname": "Aaron Liu2",
                    "avatar": "file",
                    "created_at": "2023-08-06T19:21:59+08:00"
                },
                "created_at": "2025-04-27T16:12:13+08:00",
                "expired": false,
                "url": "http://localhost:5173/s/VoMFL/2rje2bdj",
                "permission_setting": {
                    "same_group": null,
                    "everyone": "AQ==",
                    "other": null,
                    "anonymous": "AQ==",
                    "group_explicit": {},
                    "user_explicit": {}
                },
                "is_private": true,
                "password": "2rje2bdj"
            },
            {
                "id": "KDVIn",
                "name": "使用协议.txt",
                "visited": 6,
                "downloaded": 2,
                "price": 1000,
                "unlocked": true,
                "source_type": 0,
                "owner": {
                    "id": "lpua",
                    "email": "admin@cloudreve.org",
                    "nickname": "Aaron Liu2",
                    "avatar": "file",
                    "created_at": "2023-08-06T19:21:59+08:00"
                },
                "created_at": "2025-04-22T17:12:52+08:00",
                "expired": false,
                "url": "http://localhost:5173/s/KDVIn",
                "permission_setting": {
                    "same_group": null,
                    "everyone": "AQ==",
                    "other": null,
                    "anonymous": "AQ==",
                    "group_explicit": {},
                    "user_explicit": {}
                }
            }
        ],
        "pagination": {
            "page": 0,
            "page_size": 50,
            "is_cursor": true,
            "next_token": "eyJpZCI6Im1LTmxTRCJ9"
        }
    },
    "msg": ""
}
Modified at 2025-06-27 03:10:47
Previous
Get user
Next
Get storage capacity
Built with