List agents in the API key workspace

Returns the agents visible to the authenticated workspace API key. This route is non-streaming and shares the public API group rate limit of 600 requests per minute per key.

GET /agents

List agents in the API key workspace

cURL

curl --request GET \
  --url https://app.communicate.so/api/v1/agents \
  --header 'Authorization: Bearer <token>'

200

[
  {
    "id": "<string>",
    "name": "<string>",
    "status": "active"
  }
]

Authorizations

oauth2bearerAuth

Authorization · string · header · required

OAuth 2.0 client-credentials tokens bounded by the source API key scope ceiling.

Response

200

application/json

Workspace agents

id · string · required

name · string · required

status · enum<string> · required

Available options: active, inactive, draft