Get Setting

Article summary

Did you find this summary helpful?

Thank you for your feedback

Get

/api/v1/settings/{_id}

Get the settings for a specific ID. Permission required: view-privileged-setting

Version	Description
0.42.0	Added

Header parameters

X-User-Id

stringRequired

The user ID.

ExampleCkCPNctrgCDfmWLqC

X-Auth-Token

stringRequired

The authentication token.

Example1Dd4iN_ClKn5jl-xPC36snQ4s9Zd5GZnXCQuCNSKcVE

Path parameters

_id

stringRequired

The unique ID of the setting that you want to update.

Responses

200

Success Example

{
  "_id": "Livechat_enabled",
  "value": false,
  "success": true
}

object

_id

string

value

boolean

success

boolean

401

Unauthorized

Authorization Error

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

object

status

string

message

string

Was this article helpful?