Synology DSM API
  1. User
Synology DSM API
  • SYNO
    • API
      • Info
        • query
      • Auth
        • Type
          • get
        • UIConfig
          • get
        • login
        • logout
    • Core
      • Web
        • DSM
          • External
            • get
      • User
        • list
          GET
        • get
          GET
  • Template
    GET
  1. User

list

GET
/webapi/entry.cgi

Request

Authorization
Add parameter in query
_sid
Example:
_sid: ********************
Query Params

Responses

🟢200OK
application/json
Body

🟢200Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'http://localhost:5000/webapi/entry.cgi?api=SYNO.Core.User&version=1&method=list&additional=email&additional=description&additional=expired&additional=2fa_status&_sid=<api-key>'
Response Response Example
200 - Example 1
{
    "success": true,
    "data": {
        "offset": 0,
        "total": 0,
        "users": [
            {
                "name": "string",
                "email": "string",
                "expired": "string",
                "2fa_status": true
            }
        ]
    }
}
Modified at 2025-12-16 21:58:19
Previous
get
Next
get
Built with