Return scoped userdata mapping

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

SecurityBasicAuth

Request

query Parameters

scope

required

string

The scope name whose userdata you wish to retrieve.

Example: scope=example_scope

Responses

200

HTTP Request was successful.

Response Schema: application/json

apiversion	integer The version of the API.
func	string The name of the method called.
module	string The name of the module called.
	object

get/UserData/get_scoped_userdata

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

uapi --output=jsonpretty \
--user=username \
UserData \
get_scoped_userdata \
scope=ui_prefs

Response samples

application/json

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