List Agents

Updated about 2 hours ago•1 min read

GET

/v1/agents

Returns a list of all team members and agents in the current workspace with their availability status.

Parameters

Name	Type	Description
`availability`	string	Filter by availability: 'online' or 'offline'
`page`	integer	Page number (default: 1)
`per_page`	integer	Records per page (1-100, default: 50)

Responses

200List of workspace agents

{
  "data": [
    {
      "id": "usr_888",
      "name": "Sarah Connor",
      "display_name": "Sarah",
      "email": "sarah@acme.com",
      "availability": "online",
      "role": "agent"
    }
  ],
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 1
  }
}