List agents

Every agent and bot in your organization.

filters.group_ids keeps those in any of the groups.

POST/v1/configuration/action/list_agents

List agents

curl -X POST 'https://app.staging.mlive.chat/v1/configuration/action/list_agents' \
  -H "Authorization: Bearer $MLC_BOT_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{}'

const res = await fetch('https://app.staging.mlive.chat/v1/configuration/action/list_agents', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.MLC_BOT_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
});
const data = await res.json();

Response200

[
  {
    "id": "828aec20-b9c3-7700-80fb-c1e028342cc0",
    "name": "Nadia Rahman",
    "email": "nadia@shop.northwind.example",
    "role": "owner",
    "type": "human",
    "login_status": "accepting chats",
    "routing_status": "accepting_chats",
    "job_title": "Customer support",
    "avatar_path": "avatar path",
    "max_chats_count": 3,
    "groups": [
      {
        "id": 1,
        "priority": "first"
      }
    ],
    "suspended": true,
    "awaiting_approval": true
  }
]

Specifics

Method URL	`POST https://app.staging.mlive.chat/v1/configuration/action/list_agents`
Who can call it	Bots, with a bot token (`mlcb_`), and signed-in agents.

Request body

application/json

filtersobject
filters.group_idsarray of integer
filters.suspendedboolean

Response

200 · application/json

OK.

[].idstringrequired
[].namestringrequired
[].emailstring
[].rolestringrequired
One of owner, normal.
[].typestringrequired
One of human, bot.
[].login_statusstringrequired
One of accepting chats, not accepting chats.
[].routing_statusstringrequired
One of accepting_chats, not_accepting_chats, offline.
[].job_titlestring
[].avatar_pathstring
[].max_chats_countintegerrequired
[].groupsarray of objectrequired
[].suspendedbooleanrequired
[].awaiting_approvalbooleanrequired

Errors

default