Returns every agent in the bot with their current live-chat load, overall concurrency limit, availability status, group membership, and profile details. Useful for determining chat-specific agent availability when agents have separate concurrency limits configured for chat vs. tickets. The agent roster and status use the same mechanism as the internal agent-availability API, so results always match what agents see in the dashboard.
| Query Parameters |
|---|
bot string — REQUIREDThe unique ID of the bot. |
| Responses |
|---|
200
Agent concurrency data returned. | Schema — OPTIONAL |
|---|
agents object[] — OPTIONALagentId string — OPTIONAL | currentChatConcurrency integer — OPTIONALNumber of live-chat tickets currently assigned to the agent (ASSIGNED/WRAP-UP status). | maxChatConcurrency integer — OPTIONALThe agent's overall concurrency limit. Not chat-specific — agents-service has no distinct chat-only limit today, so this is the same cap that applies across all ticket types. | status string — OPTIONALPossible values: [available, dnd, away, offline] Current availability status. | groups string[] — OPTIONALGroup codes the agent belongs to. | agentProfile object — OPTIONALemail string — OPTIONAL | name string — OPTIONAL | description string — OPTIONAL | aliasname string — OPTIONAL | languages string[] — OPTIONAL | signature string — OPTIONAL |
|
|
|
| Schema — OPTIONAL |
|---|
error string — OPTIONALHuman-readable error message. |
|
| Schema — OPTIONAL |
|---|
error string — OPTIONALHuman-readable error message. |
|
| Schema — OPTIONAL |
|---|
error string — OPTIONALHuman-readable error message. |
|
| Schema — OPTIONAL |
|---|
error string — OPTIONALHuman-readable error message. |
|