Get a Priority

Get the details of a specific priority.

You are required to have the manage-livechat-priorities or view-l-room permission.

HTTP MethodURLRequires Auth

GET

/api/v1/livechat/priorities/:priorityId

Path Variables

KeyExample ValueDescription

priorityId*

64007cc2fa0ed7dd905092e3

The priority ID.

Example Call

curl --location 'http://localhost:3000/api/v1/livechat/priorities/64007cc2fa0ed7dd905092e3' \
--header 'X-Auth-Token: sMmROZpdpCTbY43XwPT_bCsWJc-VW7v_e2urWhUM766' \
--header 'X-User-Id: rYhzFRd2QZjNwAAXX'

Example Response

Success

{
    "_id": "64007cc2fa0ed7dd905092e3",
    "i18n": "Lowest",
    "sortItem": 5,
    "dirty": false,
    "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.

  • Not Found: This error gets returned when no Priority is found with the Id provided.

{
    "status": "error",
    "message": "You must be logged in to do this."
}

Change Log

VersionDescription

6.0.0

Added

Last updated

Rocket.Chat versions receive support for six months after release.