Get Private Settings

Prev Next
Get
/api/v1/settings

List all private settings. Learn how this can be used in configuring your server in this guide.

Header parameters
X-User-Id
stringRequired

The user ID.

ExampleCkCPNctrgCDfmWLqC
X-Auth-Token
stringRequired

The authentication token.

Example1Dd4iN_ClKn5jl-xPC36snQ4s9Zd5GZnXCQuCNSKcVE
Query parameters
includeDefaults
boolean

When set to true, it fetches both the current value and the default value (packageValue) of the settings

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
Responses
200

OK

Success Example
{
  "settings": [
    {
      "_id": "API_Allow_Infinite_Count",
      "value": true
    },
    {
      "_id": "API_CORS_Origin",
      "value": "*"
    }
  ],
  "count": 50,
  "offset": 0,
  "total": 299,
  "success": true
}
success example with query parameter
{
  "settings": [
    {
      "_id": "API_Allow_Infinite_Count",
      "value": true,
      "packageValue": true,
      "enterprise": false
    },
    {
      "_id": "API_Apply_permission_view-outside-room_on_users-list",
      "value": false,
      "packageValue": false,
      "enterprise": false
    },
    {
      "_id": "API_CORS_Origin",
      "value": "*",
      "packageValue": "*",
      "enterprise": false
    }
  ],
  "count": 3,
  "offset": 0,
  "total": 10,
  "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
401

Unauthorized

Authorization Error
{
  "status": "error",
  "message": "You must be logged in to do this."
}
object
status
string
message
string