User and settings API

get user info

interface address:

  • /api/user/info

HTTP request method:

  • GET

request params:
response code:

  • common response

example:

curl -X GET "$BASE_URL/api/user/info"

response example：

  • JSON:

    {
  "data": { "id": "", "user": "", "name": "", "domain": "" },
  "code": 0,
  "message": "OK"
}

get user id

interface address:

  • /api/user/id

HTTP request method:

  • GET

request params:
response code:

  • common response

get setting detail

interface address:

  • /api/setting/detail

HTTP request method:

  • GET

request params:
response code:

  • common response

update setting

interface address:

  • /api/setting/update

HTTP request method:

  • POST

request params:

  • User profile fields (name, locale, …; see the implementation)

response code:

  • common response

update password

interface address:

  • /api/setting/updatepassword

HTTP request method:

  • POST

request params:

  • Current password, new password, … (see the implementation)

response code:

  • common response

upload profile image

interface address:

  • /api/setting/uploadprofileimage

HTTP request method:

  • POST

request params:

  • multipart/form-data, uploads the avatar

response code:

  • common response

update locale (without login)

interface address:

  • /locale/update

HTTP request method:

  • POST

request params:

  • locale (form): language tag

response code:

  • common response

change password (api)

interface address:

  • /api/changepassword

HTTP request method:

  • POST

request params:

  • See the implementation (change password)

response code:

  • common response

list app user

interface address:

  • /api/appuser/list

HTTP request method:

  • GET

request params:
response code:

  • common response

create app user

interface address:

  • /api/appuser/create

HTTP request method:

  • POST

request params:

  • See the implementation (app passwords / third-party app accounts)

response code:

  • common response

delete app user

interface address:

  • /api/appuser/delete

HTTP request method:

  • POST

request params:

  • id (form, required): app user ID

response code:

  • common response

create rule (inbox rule)

interface address:

  • /api/rule/create

HTTP request method:

  • POST

request params:

  • Rule conditions, actions, … (see the implementation)

response code:

  • common response

list share

interface address:

  • /api/share/list/:id

HTTP request method:

  • GET

request params:

  • id (path): share/document ID

response code:

  • common response

create share

interface address:

  • /api/share/create

HTTP request method:

  • POST

request params:

  • See the implementation (create share links, …)

response code:

  • common response

update share

interface address:

  • /api/share/update

HTTP request method:

  • POST

request params:

  • See the implementation

response code:

  • common response

docs home list

interface address:

  • /api/docshome/list

HTTP request method:

  • GET

request params:
response code:

  • common response

list dots

interface address:

  • /api/dots/list

HTTP request method:

  • GET

request params:

  • See the implementation

response code:

  • common response

create dot (folder)

interface address:

  • /api/dots/create

HTTP request method:

  • POST

request params:

  • See the implementation

response code:

  • common response

create dot file

interface address:

  • /api/dots/createfile

HTTP request method:

  • POST

request params:

  • See the implementation

response code:

  • common response

admin api get setting

interface address:

  • /adminapi/setting

HTTP request method:

  • GET

request params:
response code:

  • common response (requires an administrator)

admin api bind mobile

interface address:

  • /adminapi/bindmobile

HTTP request method:

  • POST

request params:

  • See the implementation

response code:

  • common response

admin api get sms code

interface address:

  • /adminapi/getsmscode

HTTP request method:

  • POST

request params:

  • See the implementation

response code:

  • common response

create notice

interface address:

  • /api/notice/create

HTTP request method:

  • POST

request params:

  • See the implementation

response code:

  • common response

modelapi filter enc

interface address:

  • /modelapi/filter/enc

HTTP request method:

  • GET

request params:

  • See the implementation

response code:

  • common response