List Inboxes

Lists the inboxes in the user's current workspace.

This endpoint requires the Agent Impersonator role.

URL

GET: https://[base-url]/{applicationId}/agents/{userId}/inboxes

Headers

Authorization: Bearer <accessToken>

Request Body

N/A

Response

Success -> 200

Returns an array of Inbox objects.

Sample response:

[
    {
        "inboxId": "23ae7d4e-941f-4976-81d9-4431a56c66fa",
        "inboxName": "Consulting",
        "type": "Process",
        "position": 0,
        "priorities": {
            "defaultPriority": 1,
            "boosters": []
        },
        "queueTimestamp": "2024-05-10T08:03:32.529762Z",
        "waitingCount": 5,
        "pendingCount": 0,
        "colorCode": "#009688",
        "recordState": "Active",
        "canAccess": true
    }
]

No current unit was selected for the user -> 409, errorCode: 1010

No current workspaces -> 409, errorCode: 1011