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

# List notifications

`GET /api/notifications`

## Request

- Base URL: `https://api.typless.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.typless.com/api/notifications`
- Auth: none declared

## Query parameters

- `limit` integer, nullable
- `include_superseded` boolean
- `start_key` string, nullable

## Response `200`

Successful Response

- ListNotificationsResponse
  - `results` NotificationDTO[], required
    - `aggregate_id` string, uuid, required
    - `tenant_id` string, uuid, required
    - `user_id` string, uuid, required
    - `business_unit_id` string, uuid, nullable, required
    - `code` string, required
    - `payload` object, nullable, required
    - `reference_entity_id` string, uuid, nullable, required
    - `read_at` string, date-time, nullable, required
    - `is_superseded` boolean, required
    - `created_at` string, date-time, required
  - `last_id` string, nullable

## Other responses

- `422`: Validation Error

---

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