# Get Agents Availability Overview

## <span style="color: rgb(2, 106, 73);">**API: getAgentStatus**</span>

###  **Description**

This endpoint retrieves the current status of agents in the system, including how many are connected, paused, ready, in a call, or offline.

## 🔗 **URL**

#### https://**DOMAIN**.croco-dial.net/goAPIv2/goDashboard/goAPI.php

<p class="callout info align-left">**Note:** Replace `DOMAIN` with the specific domain you want to query.</p>

### **📝 Body Parameters**  


<table border="1" id="bkmrk-parameter-value-desc" style="border-collapse: collapse; width: 100%;"><colgroup> <col style="width: 25%;"></col> <col style="width: 25%;"></col> <col style="width: 50%;"></col> </colgroup><thead><tr><td>**Parameter**</td><td>**Value**</td><td>**Description**</td></tr></thead><tbody><tr><td>goAction</td><td>getAgentStatus</td><td>Action to perform. This parameter specifies the exact operation the API should execute.</td></tr><tr><td>goUser</td><td>MyUser</td><td>API authorized user.</td></tr><tr><td>goPass</td><td>MyPass</td><td>Authorized user's password.</td></tr><tr><td>responsetype</td><td>json/xml</td><td>Format of the response (`json` recommended).</td></tr></tbody></table>

**Note:** This endpoint uses body parameters for authentication instead of tokens or headers.

### **Request Examples:**

#### **GET:**

```bash
curl -X GET "https://DOMAIN.croco-dial.net/goAPIv2/goDashboard/goAPI.php?goAction=getAgentStatus&goUser=MyUser&goPass=MyPass&responsetype=json"
```

#### **POST (Form Data):**

If you prefer to send the data as form parameters:

```bash
curl -X POST "https://DOMAIN.croco-dial.net/goAPIv2/goDashboard/goAPI.php" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "goAction=getAgentStatus" \
  --data-urlencode "goUser=MyUser" \
  --data-urlencode "goPass=MyPass" \
  --data-urlencode "responsetype=json"

```

####  **Example Response**

```json
{
  "result": "success",
  "data": {
    "total_live_agents": 61,
    "paused_agents": 9,
    "ready_agents": 24,
    "incall_agents": 28,
    "offline_agents": 42,
    "total_active_agents": 102
  }
}

```