---
title: "List agent sessions in workspace"
method: GET
path: "/api/workspaces/{workspaceId}/agent-sessions"
tags: ["Agent Sessions"]
---

# List agent sessions in workspace

`GET /api/workspaces/{workspaceId}/agent-sessions`

## Request

- Base URL: `https://hiveship.app/api`
- URL: `https://hiveship.app/api/api/workspaces/{workspaceId}/agent-sessions`
- Auth: one of:
  - HTTP bearer
  - API key in cookie `hiveship_access`

## Path parameters

- `workspaceId` string, required

## Query parameters

- `page` integer
- `limit` integer
- `search` string
- `sortBy` string
- `sortOrder` 'asc' | 'desc'
- `status` 'QUEUED' | 'WORKING' | 'WAITING_INPUT' | 'ERRORED' | 'COMPLETED'
- `agentId` string, cuid

## Response `200`

Paginated list of sessions

- object
  - `success` boolean, required
  - `data` object, required
    - `items` object[], required
      - `id` string, cuid, required
      - `status` 'QUEUED' | 'WORKING' | 'WAITING_INPUT' | 'ERRORED' | 'COMPLETED', required
      - `issueId` string, cuid, required
      - `agentId` string, cuid, required
      - `startedAt` string, date-time, nullable, required
      - `completedAt` string, date-time, nullable, required
      - `errorMessage` string, nullable, required
      - `externalUrls` string[], required
      - `tokenUsage` integer, nullable, required
      - `modelUsed` string, nullable, required
      - `modelUsage` object[], required
        - `model` string, required
        - `inputTokens` integer, required
        - `outputTokens` integer, required
        - `cacheReadTokens` integer, required
        - `cacheWriteTokens` integer, required
        - `totalTokens` integer, required
      - `createdAt` string, date-time, 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)
