---
title: "List notifications for the current user"
method: GET
path: "/api/workspaces/{workspaceId}/notifications"
tags: ["Notifications"]
---

# List notifications for the current user

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

## Request

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

## Path parameters

- `workspaceId` string, required

## Response `200`

Paginated list of notifications for the calling user in this workspace.

- object
  - `success` boolean, required
  - `data` object, required
    - `items` object[], required
      - `id` string, cuid, required
      - `type` 'AGENT_SESSION_COMPLETED' | 'AGENT_SESSION_ERRORED' | 'ISSUE_ASSIGNED' | 'ISSUE_REVIEW_REQUESTED' | 'ISSUE_STATUS_CHANGED' | 'PR_LINKED' | 'COMMENT_REPLY' | 'MENTION' | 'ISSUE_COMMENTED' | 'ISSUE_UPDATED' | 'PLAN_EXPIRING' | 'PLAN_EXPIRED', required
      - `title` string, required
      - `body` string, nullable, required
      - `metadata` object, nullable, required
      - `isRead` boolean, required
      - `actor` object, nullable, required
        - `kind` 'user' | 'agent', required
        - `id` string, required
        - `name` string, required
        - `avatarUrl` string, nullable, 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)