Links

Get Custom Field Information

Get details about a specific custom field.
HTTP Method
URL
Requires Auth
GET
/api/v1/livechat/custom-fields/:_id
yes
Permission required: view-l-room

Path Variables

Key
Example Value
Description
_id*
address
The custom field ID.

Example Call

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

Example Response

{
"customField": {
"_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"
},
"success": true
}

Change Log

Version
Description
2.4.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.