Skip to main content
GET
List agents

Authorizations

Authorization
string
header
default:woesk_your_api_key_here
required

Workspace API key that starts with woesk_. Paste your own key into the docs playground; never expose it in browser code.

Query Parameters

Search by agent id, name, or public widget key.

Required string length: 1 - 120
enabled
boolean

Filter agents by enabled state.

isDefault
boolean

Filter to default or non-default agents.

limit
integer
default:20

Number of records to return.

Required range: 1 <= x <= 100

Response

Agent list.

object
string
required
Allowed value: "list"
hasMore
boolean
required
agents
object[]
required
Last modified on July 4, 2026