> For the complete documentation index, see [llms.txt](/llms.txt).
> A full single-fetch corpus is available at [llms-full.txt](/llms-full.txt).
---
title: "List workers"
description: "List workers. Scope the query with either project_id or deployment_id."
method: "GET"
endpoint: "/api/v1/workers"
order: 1
last_verified: 2026-07-27
---

<ApiEndpoint
  method="GET"
  endpoint="/api/v1/workers"
  description="List workers. Scope the query with either project_id or deployment_id."
>
  <section>
    ### Query parameters

    <ApiAttribute name="project_id" type="string" description="List every worker across a project's deployments. Required unless deployment_id is set." required={false} />
    <ApiAttribute name="deployment_id" type="string" description="List workers for a single deployment. Required unless project_id is set." required={false} />
    <ApiAttribute name="worker_type" type="string" description="Filter by type: application, dev, eval, or ai." required={false} />
  </section>

  <section>
    ### Request example

    <MultiLanguageCodeBlock
      languages={["bash", "javascript"]}
      value={[
        {
          language: 'bash',
          code: `curl "https://api.agnt5.com/api/v1/workers?deployment_id=8a1c2d3e-9c4d-4f7a-8e2b-1a2b3c4d5e6f" \\
  -H "X-API-KEY: {api_key}"`
        },
        {
          language: 'javascript',
          code: `fetch('https://api.agnt5.com/api/v1/workers?deployment_id=' + deploymentId, {
  headers: { 'X-API-KEY': apiKey }
})`
        }
      ]}
    />

    ```json {{ title: 'Response' }}
    {
      "success": true,
      "message": "Workers retrieved successfully",
      "data": [
        {
          "id": "f5a6b7c8-...",
          "worker_name": "invoice-processor-worker-7d9f",
          "worker_version": "1.4.2",
          "worker_type": "application",
          "deployment_id": "8a1c2d3e-...",
          "hostname": "invoice-processor-7d9f-x8k2",
          "ip_address": "10.2.4.18",
          "port": 8080,
          "status": "connected",
          "health_status": "healthy",
          "last_heartbeat": 1753612920000,
          "heartbeat_interval": 5000,
          "max_concurrent_tasks": 20,
          "current_task_count": 3
        }
      ]
    }
    ```
  </section>
</ApiEndpoint>
