Get preferences

Add the parameter

Authorization

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

Example:

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

Responses

🟢200Success

application/json

Body

data

object | 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.

group_expires

string <date-time> | null

optional

Datetime when the cuurent membership expired. Empty value means no active membership. Only presented in Pro edition.

open_id

array [object {2}] | null

optional

List of linked external identity providers. Only presented in Pro edition.

version_retention_enabled

boolean

required

Whether file version retention is enabled.

version_retention_ext

array[string] | null

optional

List of file extensions enabling file version retention. For null or empty list, all extensions are enabled.

version_retention_max

integer | null

optional

Max preserved version. For 0 or null, all version will be preserved.

passwordless

boolean

required

Whether this account is passwordless (sign in via 3rd party identity provider).

two_fa_enabled

boolean

required

Whether 2FA is enabled.

passkeys

array[object (Passkey) {4}] | null

optional

List of registered passkeys.

login_activity

array [object {9}] | null

optional

List of recent login activities. Only presented in Pro edition.

storage_packs

array [object {4}]

required

List of available extra storage packs

credit

integer

required

Available points balance.

Example:

24600

disable_view_sync

boolean

required

Whether explorer view setting sync is disabled.

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": {
        "open_id": [
            {
                "provider": 0,
                "linked_at": "2025-04-10T20:04:19+08:00"
            }
        ],
        "version_retention_enabled": true,
        "version_retention_max": 5,
        "passwordless": false,
        "two_fa_enabled": false,
        "passkeys": [
            {
                "id": "oQK4yEBXSeONnJJLN+GMkA==",
                "name": "Chrome on Mac OS X",
                "used_at": "2025-05-23T16:43:29+08:00",
                "created_at": "2025-05-23T16:43:10+08:00"
            }
        ],
        "login_activity": [
            {
                "created_at": "2025-06-12T09:24:19+08:00",
                "ip": "::1",
                "browser": "Safari",
                "device": "Mac",
                "os": "Mac OS X",
                "login_with": "",
                "open_id_provider": 0,
                "success": true,
                "webdav": false
            },
            {
                "created_at": "2025-04-01T16:46:16+08:00",
                "ip": "::1",
                "browser": "Chrome",
                "device": "Mac",
                "os": "Mac OS X",
                "login_with": "",
                "open_id_provider": 0,
                "success": false,
                "webdav": false
            }
        ],
        "storage_packs": [
            {
                "name": "Unlimited Storage",
                "active_since": "2025-03-20T17:52:20+08:00",
                "expire_at": "2026-03-20T17:52:20+08:00",
                "size": 214748364800
            }
        ],
        "credit": 24600,
        "disable_view_sync": false
    },
    "msg": ""
}

Request

Request samples

Responses