---
title: "List agents in the workspace"
method: GET
path: "/api/workspaces/{workspaceId}/agents"
tags: ["Agents"]
---

# List agents in the workspace

`GET /api/workspaces/{workspaceId}/agents`

## Request

- Base URL: `https://hiveship.app/api`
- URL: `https://hiveship.app/api/api/workspaces/{workspaceId}/agents`
- Auth: API key in cookie `hiveship_access`

## Path parameters

- `workspaceId` string, required

## Query parameters

- `page` integer
- `limit` integer
- `search` string
- `sortBy` string
- `sortOrder` 'asc' | 'desc'
- `isActive` 'true' | 'false'

## Response `200`

Paginated list of agents

- object
  - `success` boolean, required
  - `data` object, required
    - `items` object[], required
      - `id` string, cuid, required
      - `name` string, required
      - `provider` 'CURSOR' | 'CLAUDE_CODE' | 'CODEX' | 'AIDER' | 'DEVIN' | 'COPILOT' | 'CUSTOM', required
      - `scope` 'READ' | 'SESSION' | 'WORKSPACE', required
      - `avatarUrl` string, nullable, required
      - `avatarKey` string, nullable, required
      - `isActive` boolean, required
      - `sessionCount` integer, required
      - `activeSessionCount` integer, required
      - `hasApiToken` boolean, required
      - `apiTokenRotatedAt` string, date-time, nullable, required
      - `apiTokenHint` string, nullable, required
      - `lastActivityAt` string, date-time, nullable, required
      - `recentSessionStatuses` string[], required
      - `owner` object, nullable, required
        - `id` string, cuid, required
        - `name` string, required
        - `avatarUrl` string, nullable, required
      - `dispatchWebhookUrl` string, nullable, required
      - `dispatchSecretHint` string, nullable, required
    - `meta` object, required
      - `page` integer, required
      - `limit` integer, required
      - `total` integer, required
      - `totalPages` integer, required
      - `hasNext` boolean, required
      - `hasPrev` boolean, required

---

[API](https://skmtc.dev/hiveship/apis/hiveship-api.md) · [All operations](https://skmtc.dev/hiveship/apis/hiveship-api/llms.txt) · [OpenAPI document](https://skmtc.dev/hiveship/apis/hiveship-api/revisions/73d3e26544e4?raw)