get-priorities.md

Get List of Priorities

{% hint style="info" %} You are required to have the manage-livechat-priorities or view-l-room permission. {% endhint %}

HTTP Method	URL	Requires Auth
GET	/api/v1/livechat/priorities	yes

Query Parameters

This endpoint supports the optional #pagination parameters.

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'

Example Response

Success

{
    "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.

{% tabs %} {% tab title=" Authorization" %}

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

{% endtab %}

{% tab title="No Permission" %}

{
    "success": false,
    "error": "error-not-authorized"
}

{% endtab %} {% endtabs %}

Change Log

Version	Description
6.0.0	Added