Get Public Settings

Prev Next
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
7.0.0 Added the _id query parameter for filtering.
7.0.0 Removed the query parameter.
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
count
integer

How many items to return. Refer to the official documentation to learn more.

Example50
fields

This parameter accepts a JSON object with properties that have a value of 1 or 0 to include or exclude them in the response. For example, to only retrieve the usernames of users: fields={ "username": 1 }. Refer to the official documentation to learn more.

_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} or sort={"createdAt": -1}
  • _id: Sort by setting ID. sort={"_id": 1} or sort={"_id": -1}
Responses
200

OK

Success Example
{
  "settings": [
    {
      "_id": "API_Drupal_URL",
      "value": ""
    },
    {
      "_id": "API_Embed",
      "value": true
    }
  ],
  "count": 2,
  "offset": 0,
  "total": 2,
  "success": true
}
Expand All
object
settings
Array of object
object
_id
string
value
OneOf
boolean
boolean
string
string
count
integer
offset
integer
total
integer
success
boolean