Get Livechat Custom Fields

Prev Next
Get
/api/v1/livechat/custom-fields

Get a list of the Livechat custom fields. Permission required: view-l-room

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

The number of items to return. Refer to the official documentation to learn more.

Example25
sort
(object)

List of fields to order by, and in which direction. JSON object, with properties listed in desired order, with values of 1 for ascending, or -1 for descending. For example, sort = {"value": -1, "_id": 1}. Refer to the official documentation to learn more.

text
string

Enter the text to filter the search result.

Responses
200

OK

Success Example
{
  "customFields": [
    {
      "_id": "address",
      "label": "address",
      "scope": "visitor",
      "visibility": "visible",
      "regexp": "",
      "searchable": true,
      "type": "input",
      "required": false,
      "defaultValue": "",
      "options": "",
      "public": true,
      "_updatedAt": "2023-10-30T13:43:09.408Z",
      "id": "address"
    }
  ],
  "count": 1,
  "offset": 0,
  "total": 1,
  "success": true
}
Expand All
object
customFields
Array of object
object
_id
string
label
string
scope
string
visibility
string
regexp
string
searchable
boolean
type
string
required
boolean
defaultValue
string
options
string
public
boolean
_updatedAt
string
id
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
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