---
title: "Search issues, projects, and comments within a workspace"
method: GET
path: "/api/workspaces/{workspaceId}/search"
tags: ["Search"]
---

# Search issues, projects, and comments within a workspace

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

## Request

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

## Path parameters

- `workspaceId` string, required

## Response `200`

Issues + projects + comments matching the query (each capped by the `limit` param).

- object
  - `success` boolean, required
  - `data` object, required
    - `issues` object[], required
      - `id` string, cuid, required
      - `triageSource` string, nullable, required
      - `number` integer, required
      - `title` string, required
      - `status` string, required
      - `priority` 'URGENT' | 'HIGH' | 'MEDIUM' | 'LOW' | 'NONE', required
      - `delegateType` 'HUMAN' | 'AGENT', required
      - `assignee` object, nullable, required
        - `id` string, cuid, required
        - `name` string, required
        - `avatarUrl` string, nullable, required
      - `agent` object, nullable, required
        - `id` string, cuid, required
        - `name` string, required
        - `avatarUrl` string, nullable, required
        - `provider` 'CURSOR' | 'CLAUDE_CODE' | 'CODEX' | 'AIDER' | 'DEVIN' | 'COPILOT' | 'CUSTOM', required
      - `labels` object[], required
        - `id` string, cuid, required
        - `name` string, required
        - `color` string, required
      - `commentCount` integer, required
      - `linkedPRCount` integer, required
      - `linkedPRStatus` 'open' | 'merged' | 'closed', nullable, required
      - `linkedPRReviewState` 'approved' | 'changes_requested', nullable, required
      - `projectPrefix` string, required
      - `project` object, required
        - `id` string, cuid, required
        - `name` string, required
        - `prefix` string, required
      - `storyPoints` integer, nullable, required
      - `dueDate` string, date-time, nullable, required
      - `activeSession` object, nullable, required
        - `id` string, cuid, required
        - `agentId` string, cuid, required
        - `agentName` string, required
        - `startedAt` string, date-time, required
        - `tokenUsage` integer, nullable, required
        - `modelUsed` string, nullable, required
      - `latestActivity` object, nullable, required
        - `kind` 'THOUGHT' | 'TOOL_USE' | 'ELICITATION' | 'RESPONSE' | 'ERROR', required
        - `summary` string, required
        - `createdAt` string, date-time, required
      - `completedBy` object, nullable, required
        - `agentId` string, cuid, required
        - `agentName` string, required
      - `projectId` string, cuid, required
    - `projects` object[], required
      - `id` string, cuid, required
      - `name` string, required
      - `slug` string, required
      - `prefix` string, required
      - `description` string, nullable, required
      - `status` 'BACKLOG' | 'PLANNED' | 'IN_PROGRESS' | 'PAUSED' | 'COMPLETED' | 'CANCELLED' | 'ACTIVE' | 'ARCHIVED', required
      - `health` 'ON_TRACK' | 'AT_RISK' | 'OFF_TRACK', nullable, required
      - `lead` object, nullable, required
        - `id` string, cuid, required
        - `name` string, required
        - `avatarUrl` string, nullable, required
      - `startDate` string, date-time, nullable, required
      - `targetDate` string, date-time, nullable, required
      - `progress` object, required
        - `total` integer, required
        - `byBucket` object, required
          - `backlog` integer, required
          - `unstarted` integer, required
          - `started` integer, required
          - `completed` integer, required
          - `cancelled` integer, required
      - `issueCount` integer, required
      - `openIssueCount` integer, required
      - `memberCount` integer, required
      - `isInbox` boolean, required
    - `comments` object[], required
      - `id` string, cuid, required
      - `snippet` string, required
      - `authorName` string, required
      - `createdAt` string, required
      - `issueId` string, cuid, required
      - `issueNumber` integer, required
      - `issueTitle` string, required
      - `projectId` string, cuid, required
      - `projectPrefix` string, 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)