---
title: "Get a project"
method: GET
path: "/api/workspaces/{workspaceId}/projects/{projectId}"
tags: ["Projects"]
---

# Get a project

`GET /api/workspaces/{workspaceId}/projects/{projectId}`

## Request

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

## Path parameters

- `workspaceId` string, required
- `projectId` string, required

## Response `200`

Project details

- object
  - `success` boolean, required
  - `data` 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

## Other responses

- `404`: Project not found

---

[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)