Skip to main content
GET
/
agent
/
list
List Agents
curl --request GET \
  --url https://api.example.com/agent/list

List Agents

Get a paginated list of all agents associated with your account.

Endpoint

GET /agent/list

Authentication

Requires JWT token or Platform API key.

Query Parameters

ParameterTypeDefaultDescription
pagenumber1Page number (min: 1)
limitnumber20Results per page (1-100)
statusstring-Filter by status (active, paused, stopped, error)
sortstringcreated_atSort field (created_at, updated_at, name)
orderstringdescSort order (asc, desc)

Example Request

curl -X GET "https://api.app.shinzo.ai/agent/list?limit=10&status=active" \
  -H "Authorization: Bearer <jwt_token>"

Response

{
  "agents": [
    {
      "uuid": "agt_abc123def456",
      "name": "code-review-agent",
      "description": "Agent for automated code reviews",
      "status": "active",
      "created_at": "2025-01-15T10:00:00Z",
      "updated_at": "2025-01-18T14:30:00Z",
      "task_count": 45,
      "active_tasks": 1
    },
    {
      "uuid": "agt_xyz789uvw012",
      "name": "data-analysis-agent",
      "description": "Agent for data analysis tasks",
      "status": "paused",
      "created_at": "2025-01-10T08:00:00Z",
      "updated_at": "2025-01-12T09:15:00Z",
      "task_count": 12,
      "active_tasks": 0
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 2,
    "total_pages": 1
  }
}

Response Fields

FieldTypeDescription
uuidstringUnique agent identifier
namestringAgent name
descriptionstringAgent description
statusstringCurrent status
created_atstringCreation timestamp
updated_atstringLast update timestamp
task_countnumberTotal tasks executed
active_tasksnumberCurrently running tasks

Status Codes

CodeDescription
200Success
401Invalid authentication
403AI Agents feature not enabled