Get
/api/v1/settings.public
List all public settings. Learn how this can be used in configuring your workspace in this guide.
Changelog
| Version | Description |
|---|---|
| 9.0.0 | Removed the fields and query parameters. |
| 7.0.0 | Added the _id query parameter for filtering. |
Query parameters
offset
integer
Number of items to "skip" in the query, i.e. requests return count items, skipping the first offset items. Refer to the official documentation to learn more.
Example50
Example50
_id
string
Filter by the _id of the settings.
ExampleSite_Url, LDAP_Enable
sort
string
Sort the settings in ascending or descending order. By default, settings are sorted by setting ID in ascending order. The sort options are:
createdAt: Sort by creation date.sort={"createdAt": 1}orsort={"createdAt": -1}_id: Sort by setting ID.sort={"_id": 1}orsort={"_id": -1}
Responses
200
OK
Success Example
{
"settings": [
{
"_id": "API_Embed",
"value": true
}
],
"count": 1,
"offset": 0,
"total": 1,
"success": true
}object
settings
Array of object
object
_id
string
value
boolean, string
count
integer
offset
integer
total
integer
success
boolean