---
title: "List registered agents and their online status"
method: GET
path: "/api/v1/agents"
tags: ["Agents"]
---

# List registered agents and their online status

`GET /api/v1/agents`

## Request

- Base URL: `https://getorquesta.com`
- URL: `https://getorquesta.com/api/v1/agents`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-Key`

## Response `200`

Agent list.

- object
  - `agents` Agent[], required
    - `id` string, uuid, required
    - `name` string, nullable
    - `status` 'online' | 'offline' | 'idle', required
    - `lastSeen` string, date-time, nullable
    - `agentInfo` object, nullable: Hostname, version, platform reported by the agent
    - `project` object, nullable
      - `id` string, uuid
      - `name` string
      - `agentOnline` boolean
      - `productionUrl` string, nullable
      - `githubRepo` string, nullable
    - `createdAt` string, date-time, required

## Other responses

- `401`: Missing or invalid API key.
- `403`: Insufficient scope, revoked token, or project-scope mismatch.

---

[API](https://skmtc.dev/getorquesta/apis/orquesta-public-api.md) · [All operations](https://skmtc.dev/getorquesta/apis/orquesta-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/getorquesta/apis/orquesta-public-api/revisions/7d27e0ae8324?raw)