Search user

GET

/user/search

Auth: JWT Required

Search other users by display name of email.

Request

Authorization

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Query Params

keyword

string

required

Search keyword, can be part of display name or email.

>= 2 characters

Example:

Aaron

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

data

array [object {6}] | null

optional

Response content. In some error type, e.g. lock conflicting errors, this field wil present details of the error, e.g. who is locking the current file.

string

required

ID of the user.

Example:

6JIo

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:

Example:

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": [
        {
            "id": "lpua",
            "email": "admin@cloudreve.org",
            "nickname": "Aaron Liu",
            "avatar": "file",
            "created_at": "2023-08-06T19:21:59+08:00",
            "group": {
                "id": "z4u4",
                "name": "管理员"
            }
        },
        {
            "id": "gymfz",
            "email": "a1e4b09e-8332-44a2-8c2e-de95b1ead741@openid.unmanaged",
            "nickname": "Aaron Liu",
            "created_at": "2025-02-08T13:57:26+08:00",
            "group": {
                "id": "1AI8",
                "name": "User"
            }
        }
    ],
    "msg": ""
}

Modified at 2025-06-27 03:11:24

Get storage capacity

List credit changes