Chat icon

Chat

Interact with the Chat API

Actions253

Assignable Agents → List

AI-generated

Summary

List assignable agents for a given account and inbox.

Inputs

  • accountId (required) — The account from which to list assignable agents.
  • inboxId (required) — The inbox within the account to list assignable agents.
  • returnAll — If true, return all agents without pagination limits; otherwise limited by limit.
  • limit — Maximum number of agents to return when returnAll is false; default 50.

Output shape

An array of assignable agent objects.

The response contains the listed agents; pagination is controlled by returnAll and limit parameters.

Examples

Example 1: List agents for account 123 and inbox 456 with default limit.

accountId=123, inboxId=456, returnAll=false, limit=50

Example 2: Retrieve all assignable agents for a given inbox.

accountId=789, inboxId=101, returnAll=true

Example 3: Fetch a limited set of agents for account 123, limiting to 20 results.

accountId=123, inboxId=456, returnAll=false, limit=20

Links

Discussion