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

# List notifications

`GET /notifications`

## Request

- Base URL: `https://app.mammoth.io/api/v2`
- URL: `https://app.mammoth.io/api/v2/notifications`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-KEY` and API key in header `X-API-SECRET` and API key in header `X-WORKSPACE-ID`

Returns notifications for the user's workspaces, with optional filters for status, read state, scope, and time range.

## Query parameters

- `fields` string, nullable: Fields to be returned in a comma-separated format may include id, workspace_id, details
- `workspace_id` integer, nullable: Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.
- `project_id` integer, nullable: Project ID of the workspace
- `last_updated_at__gte` string, nullable: Filter notifications updated greater than or equal to the given timestamp. Format: ISO 8601 (e.g. '2023-01-01T00:00:00Z')
- `status` string, nullable: Filter notifications by status
- `is_read` boolean, nullable: Filter notifications read status
- `notification_scope` 'workspace' | 'project' | 'user': Notifications can be scoped in these types.
- `limit` integer: Max number of result to return
- `offset` integer: Distance from the beginning of the list of results
- `sort` string: Returned results are sorted by the combination of the given fields.

## Response `200`

List of notifications

- NotificationListResponse
  - `notifications` NotificationSchema[], required
    - `id` integer, nullable: Unique identifier of the notification
    - `workspace_id` integer, nullable: Workspace the notification belongs to
    - `last_updated_at` string, date-time, nullable: Timestamp of the last update to the notification
    - `project_id` integer, nullable: Project the notification is associated with
    - `details` object, nullable: Notification payload details such as title, body, and contextual metadata
    - `status` 'inited' | 'processing' | 'dismissed' | 'deleted' | 'completed' | 'error'
    - `type` 'TRANSIENT' | 'REQUIRES_USER_DISMISSAL' | 'WARNING_NOTICE' | 'CONFIRMATION'
    - `data_updated_at` string, date-time, nullable: Timestamp when the underlying data that triggered the notification was last updated
    - `is_read` boolean, nullable: Whether the notification has been read by the user
    - `scope` 'workspace' | 'project' | 'user': Notifications can be scoped in these types.
    - `scope_id` integer, nullable: Identifier of the scoped resource; -1 indicates no specific resource
    - `expires_at` string, date-time, nullable: Timestamp after which the notification is considered expired

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Request forbidden -- authorization will not help

---

[API](https://skmtc.dev/mammoth/apis/mammoth-analytics.md) · [All operations](https://skmtc.dev/mammoth/apis/mammoth-analytics/llms.txt) · [OpenAPI document](https://skmtc.dev/mammoth/apis/mammoth-analytics/revisions/5dfd1c296ded?raw)