get-available-agent-information.md

Get Available Agent Information

Get information about the currently available agent.

HTTP Method	URL	Requires Auth
GET	/api/v1/omnichannel/agents/available	yes

Query Parameters (Optional)

Supports the #pagination parameters. Additional query parameters are as follows:

Key	Data Type	Description
query	string	Use the query operator to search for specific data. For more information, see #query-and-fields
text	string	The response is the data that contains this text.
includeExtension	string	The voice channel extension associated with the agent. If you don't enter any extension number, the endpoint returns a list of all agents who have not been assigned any extensions. For information about extensions, see Associate agents with extensions in Rocket.Chat.

Example Call

{% code overflow="wrap" %}

curl --location 'http://localhost:3000/api/v1/omnichannel/agents/available' \
--header 'X-Auth-Token: Y97tM4GkYjgaH_fIO5dwBitQQvm3yp-AptYzGQZMX6e' \
--header 'X-User-Id: CkCPNcvsvCDfmWLqC' \
--data ''

{% endcode %}

Example Response

{
    "agent": {
        "_id": "XycfA5CetCPuEjqxw",
        "username": "test.agent",
        "name": "agent123",
        "status": "online",
        "statusLivechat": "online",
        "emails": [
            {
                "address": "agent123@rocket.chat",
                "verified": true
            }
        ],       
        "livechat": {
            "maxNumberSimultaneousChat": "5"
        }
    },
    "success": true
}