Get Settings
This operation is part of the User Settings API section of the Web Services API.
Overview
Returns an array of settings for the specified group.
Request URL | /users/{id}/settings/{group-name} or /me/settings/{group-name} |
---|---|
HTTP Method | GET |
Required Features | api-provisioning-read |
Samples
Request
GET /api/v2/settings/my-setting-group
HTTP Response
Important
The "key" attribute specifies which of the settings attributes should be used as a key to identify the setting for modification requests. If the "key" attribute is not present, Web Services uses the "name" attribute.{
"statusCode": 0,
"key":"name",
"settings":[
{
"name":"My First Setting",
"value":"red"
},
{
"name":"My Second Setting",
"value":"orange"
}
]
}
This page was last edited on October 31, 2023, at 13:32.
Comments or questions about this documentation? Contact us for support!