Links

Get one Tag

Gives the details of a tag
This endpoint has been renamed to Get a Tag as from Rocket.Chat 5.0
URL
Requires Auth
HTTP Method
livechat/tags.getOne
YES
GET

Headers

Argument
Example
Required
Description
X-User-Id
myuser-name
Required
Your username hash (returned after you log in through the API)
X-Auth-Token
myauth-token
Required
Your token (returned after you log in through the API)

Parameters

Argument
Example
Required
Description
tagId
pXkCRLGxD34y2FEZq
Required
Tag ID

Example Call

curl --location --request GET 'http://localhost:3000/api/v1/livechat/tags.getOne?tagId=pXkCRLGxD34y2FEZq\
--header 'X-Auth-Token: myauth-token' \
--header 'X-User-Id: myuser-name'

Result

{
"_id": "pXkCRLGxD34y2FEZq",
"name": "Valuable lead",
"description": "high chances of conversion",
"numDepartments": 1,
"departments": [
"GgYvrkAF63aeQmsh4"
],
"_updatedAt": "2021-06-28T16:43:57.688Z",
"success": true
}
Last modified 17h ago
Deprecation for cloud services and apps is now extended to November 20, 2023. Rocket.Chat versions receive support for six months after release.