list-livechat-custom-fields.md

Get Livechat Custom Fields

Get a list of the Livechat custom fields.

HTTP Method	URL	Requires Auth
GET	/api/v1/livechat/custom-fields	yes

{% hint style="info" %} Permission required: view-l-room {% endhint %}

Query Parameters

This endpoint supports the #pagination query parameters.

Example Call

curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
     -H "X-User-Id: aobEdbYhXfu5hkeqG" \
     http://localhost:3000/api/v1/livechat/custom-fields

Example Response

{
    "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
}

Change Log

Version	Description
2.2.0	Added