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

Get user

GET
/user/info/{user_id}
Auth: JWT Optional
Get user by ID. Authorization is optional, but email field will be redacted for anonymous request.

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
User ID.
Example:
Nru9

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/info/Nru9'

Responses

🟢200Success
application/json
Body
data
object 
required
Response content
id
string 
required
ID of the user.
Example:
6JIo
email
string  | null 
optional
Email of the user. For anonymous session, it is empty.
nickname
string  | null 
required
Display name of the user.
Example:
Johnny Zhang
created_at
string <date-time>
required
Time at which the user is created. For anonymous session, this value is invalid.
Example:
2023-08-06T19:21:59+08:00
group
object 
required
avatar
enum<string>  | enum<null> 
required
Source type of the profile picture. Empty value indicates no profile picture.
Allowed values:
filegravatar
Example:
file
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
{
    "data": {
        "id": "6JIo",
        "email": "Estevan92@gmail.com",
        "nickname": "Johnny Zhang",
        "created_at": "2023-08-06T19:21:59+08:00",
        "group": {
            "id": "1AI8",
            "name": "Admin"
        }
    },
    "code": 0,
    "msg": ""
}
Modified at 2025-06-27 03:10:30
Previous
Get profile picture
Next
List user's share links
Built with