Get Agents of Department

Get the agents of a specific department.

HTTP MethodURLRequires Auth

GET

/api/v1/livechat/department/:_id/agents

Permissions required:

  • view-livechat-departments

  • view-l-room

Query Parameters

This endpoints supports the Pagination query parameters.

Path Variables

KeyExample ValueDescription

_id*

BiqbQav59HD2LzXEY

The department ID.

Example Call

curl --location 'https://writing-demo.dev.rocket.chat/api/v1/livechat/department/649230d479f5c6e272/agents' \
--header 'X-Auth-Token: oKUJdR1jFvJ7kNEIYBqAX' \
--header 'X-User-Id: CkCPNcvsvCDfmWLqC'

Example Response

{
    "agents": [
        {
            "_id": "SWugWdHhcTX4G2NAP",
            "agentId": "rocket.cat",
            "departmentId": "BiqbQav59HD2LzXEY",
            "_updatedAt": "2021-07-14T14:58:01.013Z",
            "count": 17,
            "departmentEnabled": true,
            "order": 0,
            "username": "rocket.cat"
        }
    ],
    "count": 1,
    "offset": 0,
    "total": 1,
    "success": true
}

Last updated

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