---
title: "agents_status"
slug: "agents-status"
updated: 2024-10-25T11:02:05Z
published: 2024-10-25T11:02:05Z
canonical: "docs.voiso.com/agents-status"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.voiso.com/llms.txt
> Use this file to discover all available pages before exploring further.

# agents_status

Get/api/v1/{api_key}/agents_status

Returns the user list with relevant email, extension, and current status.

Path parametersapi_keystringRequired

The [Contact Center API key](https://developers.voiso.com/client/#/rest/getting-started/authentication/how-to-obtain-the-contact-center-key).

Example{contact_center_api_key}

Responses200

Success

<select class='api-response-data' aria-label='Media type'><option value='93b2ee21-cca8-4c56-93f7-e204cb62ff3b'>application/json</option>
</select><select class='select-example' aria-label='Media type'><option value='00abf1c5-b6d6-4551-96aa-cd9c9174511f'>example1</option>
</select>example1

Agent status

Array of agent's data and status

```json
[
  {
    "email": "pt@fg.com",
    "ext": "7777",
    "status": "available"
  },
  {
    "email": "px@fg.com",
    "ext": "5555",
    "status": "unavailable"
  }
]
```

Array of object   

Array of agent's data and status

Example[
  {
    "email": "pt@fg.com",
    "ext": "7777",
    "status": "available"
  },
  {
    "email": "px@fg.com",
    "ext": "5555",
    "status": "unavailable"
  }
]object 

Returns the user list with relevant email, extension, and current status.

emailstring    

The agent's email.

extstring   | null  

The agent's extension.

statusValid values[
  "offline",
  "available",
  "unavailable",
  "inbound",
  "outbound",
  "dialer",
  "postcall"
]

403

Invalid api_key

<select class='api-response-data' aria-label='Media type'><option value='708a29f6-2d89-41c1-9432-fc5d041a81de'>application/json</option>
</select><select class='select-example' aria-label='Media type'><option value='5de059e8-84ce-4182-9f16-45ea3c39bce7'>example1</option>
</select>example1

Error1

Invalid API key

```json
{
  "error": "Invalid api_key"
}
```

Example{
  "error": "Invalid api_key"
}

415

This type of request is not supported by the server

<select class='api-response-data' aria-label='Media type'><option value='0643db96-3c6c-4606-8a0a-85c84dff5a2f'>application/json</option>
</select>

503

Server error

<select class='api-response-data' aria-label='Media type'><option value='b9543b33-2174-4a90-b90f-93f98d98e306'>application/json</option>
</select>