get_agents_compact
Retrieve a compact list of agents and AI assistants—ID, name, email, enabled status, and availability—for selecting a conversation assignee; use each returned ID as assignee_id.
Instructions
Get Agents Compact
Agents and AI assistants in a short form (ID, name, email, enabled, availability), the list the web UI offers when assigning a conversation. Any authenticated agent, unlike get_agents which needs users:manage. Use the returned id as assignee_id of update_user_assignee.
GET /api/v1/agents/compact
Tags: Agents
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| q | No | Case-insensitive substring of the name (agents: also matched on the email) (query parameter) | |
| ids | No | Comma-separated IDs (at most 200, non-numeric or non-positive entries are ignored). When given, only these are returned and every other filter and the pagination are ignored (query parameter) | |
| page | No | Page number, used when page_size is set (query parameter) | |
| type | No | Keep only this kind of user. Any other value is a 400 (query parameter) | |
| enabled | No | Only the exact value `true` keeps the enabled users; anything else returns enabled and disabled ones (query parameter) | |
| page_size | No | Items per page, at most 500. 0 or absent: return every match (query parameter) |