Links

Get Livechat Custom Fields

Get a list of the Livechat custom fields.
HTTP Method
URL
Requires Auth
GET
/api/v1/livechat/custom-fields
yes
Permission required: view-l-room

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
Last modified 6d ago
Deprecation for cloud services and apps is now extended to November 20, 2023. Rocket.Chat versions receive support for six months after release.