Skip to main content
GET
/
agents
List agents
curl --request GET \
  --url https://api.getarbol.com/v1/agents \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "id": "agt_abc123",
      "name": "<string>",
      "primaryLanguage": "<string>",
      "status": "ACTIVE",
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123,
  "hasMore": true,
  "nextCursor": "<string>"
}

Authorizations

Authorization
string
header
required

Use your API key from the Arbol dashboard. Go to Settings > API Keys to generate one.

Query Parameters

limit
integer
default:50

Max items to return (1-100)

Required range: 1 <= x <= 100
offset
integer
default:0

Items to skip

Required range: x >= 0
status
enum<string>

Filter by agent status

Available options:
ACTIVE,
PAUSED,
INACTIVE

Search agents by name

Response

List of agents

items
object[]
total
integer
hasMore
boolean
nextCursor
string | null