---
title: "List notifications"
method: GET
path: "/notifications"
tags: ["Notifications"]
---

# List notifications

`GET /notifications`

## Request

- Base URL: `https://joinways.app/api/v1`
- URL: `https://joinways.app/api/v1/notifications`
- Auth: one of:
  - HTTP bearer
  - OAuth 2 (authorization code, authorization URL `https://joinways.app/oauth/authorize`, token URL `https://joinways.app/api/oauth/token`, scopes: `mcp.read`)

The token owner's own notifications for this workspace (the bell of the app: the workspace's notices and the user's personal ones scoped to it or to no workspace), newest first. Expired notifications are left out. **Role permission:** none (any member).

## Query parameters

- `page` integer
- `per_page` integer
- `unread_only` boolean
- `category` string
- `created_from` string, date-time
- `created_to` string, date-time

## Response `200`

Page of notifications.

- object: Envelope wrapping a page of results.
  - `data` Notification[], required: The page of results (item type depends on the endpoint).
    - `id` integer
    - `type` 'info' | 'warning' | 'error'
    - `body` string
    - `link` string, nullable
    - `channel` 'in_app' | 'email'
    - `category` string, nullable
    - `dismissed` boolean: Read.
    - `status` string: `open` or `done`.
    - `expires_at` string, date-time, nullable
    - `created_at` string, date-time
    - `triggered_by_user_id` string, uuid, nullable
  - `pagination` object, required
    - `page` integer, required: Current 1-based page.
    - `per_page` integer, required: Items per page.
    - `total` integer, nullable, required: Total matching items across all pages (`null` only on a page past the last one, when unknown).
    - `total_pages` integer, nullable, required

## Other responses

- `401`: Missing, invalid, expired or revoked bearer token (`unauthorized`).
- `429`: Too many requests (`rate_limited`). `details.reason`: `per-ip`, `per-account-minute`, `per-account-day`, or `email_rate_limited` (email budget). Always carries `Retry-After`: wait that many seconds.

---

[API](https://skmtc.dev/joinways/apis/joinways-public-api.md) · [All operations](https://skmtc.dev/joinways/apis/joinways-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/joinways/apis/joinways-public-api/revisions/39e84309953e?raw)