v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB

UserData

Return scoped userdata mapping

This function returns all userdata key/value pairs for a given scope.

get/UserData/get_scoped_userdata

Query parameters

scopestring required

Example:example_scope

The scope name whose userdata you wish to retrieve.

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

{
  "apiversion": 3,
  "func": "get_scoped_userdata",
  "module": "UserData",
  "result": {
    "data": {
      "theme": "dark",
      "items_per_page": "50",
      "show_help_tour": "0"
    },
    "status": 1
  }
}