Links

Get Priorities

Get a list of all priorities
It supports the Pagination parameters.
You are required to have the manage-livechat-priorities or view-l-room permission.
URL
Requires Auth
HTTP Method
livechat/priorities
YES
GET

Headers

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

Example Call

curl --location --request GET 'http://localhost:3000/api/v1/livechat/priorities\
--header 'X-Auth-Token: myauth-token' \
--header 'X-User-Id: myuser-id'

Result

{
"priorities": [
{
"_id": "64007cc2fa0ed7dd905092e3",
"i18n": "Lowest",
"sortItem": 5,
"dirty": false
},
{
"_id": "64007cc2fa0ed7dd905092e4",
"i18n": "Low",
"sortItem": 4,
"dirty": false
},
{
"_id": "64007cc2fa0ed7dd905092e5",
"i18n": "Medium",
"sortItem": 3,
"dirty": false
},
{
"_id": "64007cc2fa0ed7dd905092e6",
"i18n": "High",
"sortItem": 2,
"dirty": false
},
{
"_id": "64007cc2fa0ed7dd905092e7",
"i18n": "Highest",
"sortItem": 1,
"dirty": false
}
],
"count": 5,
"offset": 0,
"total": 5,
"success": true
}

Error

Any of the following errors can occur on the endpoint.
  • Authorization: Requires an authentication token for the request to be made.
  • No Permission: This occurs when the authenticated user doesn't have manage-livechat-priorities or view-l-room permission.
Authorization
No Permission
{
"status": "error",
"message": "You must be logged in to do this."
}
{
"success": false,
"error": "error-not-authorized"
}

Change Log

Version
Description
6.0.0
Added
Last modified 2mo ago
Deprecation for cloud services and apps is now extended to November 20, 2023. Rocket.Chat versions receive support for six months after release.