Skip to main content

ListAgents lists agents with filtering and pagination.

GET 
/api/v1/voice/agents

Returns agents matching the specified criteria.

Filtering​

  • status: Filter by administrative status
  • current_status: Filter by real-time availability
  • type: Filter by connection type
  • did_id: Filter by assigned DID
  • user_id: Filter by linked user
  • search: Search in name and extension

Sorting​

Supported fields: name, extension, type, status, current_status, created_at, updated_at

Pagination​

  • page: Page number (default: 1)
  • per_page: Results per page (default: 20, max: 100)

Errors​

  • PERMISSION_DENIED: Caller lacks voice:agent:read permission

Request​

Responses​

A successful response.