Get Livechat Integrations

Prev Next
Get
/api/v1/livechat/integrations.settings

Retrieves a list of integration settings. Permission required: view-livechat-manager

Changelog

Version Description
2.2.0 Added
Header parameters
X-Auth-Token
stringRequired

The authToken of the authenticated user.

ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired

The userId of the authenticated user.

ExamplerbAXPnMktTFbNpwtJ
Responses
200

OK

Success Example
{
  "settings": [
    {
      "_id": "Livechat_secret_token",
      "_updatedAt": "2019-10-17T13:56:07.285Z",
      "autocomplete": true,
      "blocked": false,
      "createdAt": "2019-10-07T18:52:20.484Z",
      "group": "Livechat",
      "hidden": false,
      "i18nDescription": "Livechat_secret_token_Description",
      "i18nLabel": "Secret_token",
      "packageValue": "",
      "secret": true,
      "section": "CRM_Integration",
      "sorter": 25,
      "ts": "2019-10-07T21:00:01.287Z",
      "type": "string",
      "value": "",
      "valueSource": "meteorSettingsValue",
      "meteorSettingsValue": ""
    }
  ],
  "success": true
}
Expand All
object
settings
Array of object
object
_id
string
_updatedAt
string
autocomplete
boolean
blocked
boolean
createdAt
string
group
string
hidden
boolean
i18nDescription
string
i18nLabel
string
packageValue
string
secret
boolean
section
string
sorter
integer
ts
string
type
string
value
string
valueSource
string
meteorSettingsValue
string
success
boolean
401

Unauthorized

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

Forbidden

Permission Error
{
  "success": false,
  "error": "User does not have the permissions required for this action [error-unauthorized]"
}
Unauthorized
{
  "success": false,
  "error": "unauthorized"
}
object
success
boolean
error
string