# GET /api/v1/notifications

> List notifications

- **Tag:** notifications
- **Operation ID:** `list_notifications_api_v1_notifications_get`

## Description

Get the caller's notification feed across all scopes

## Authentication

Bearer token in `Authorization` header.
Required header: `x-business-id: <business uuid>`.

## Parameters

- `scope` (query, NotificationScopeEnum, optional) — Scope: 'me' (default), 'business', or 'firm'
- `scope_id` (query, string, optional) — Required when scope is 'business' or 'firm'
- `status` (query, array · NotificationStatusEnum, optional) — Filter to one or more statuses
- `topic` (query, array · NotificationTopicEnum, optional) — Filter to one or more topics
- `severity` (query, array · NotificationSeverityEnum, optional) — Filter to one or more severities
- `include_terminal` (query, boolean, optional) — Include resolved + dismissed rows
- `include_snoozed` (query, boolean, optional) — Include snoozed rows whose timer hasn't elapsed
- `include_live` (query, boolean, optional) — Merge live alerts (low cash, plaid stale, etc.) as virtual rows when a business context is available.
- `live_business_id` (query, string, optional) — When scope='me', merge live alerts for this specific business id.  Ignored for scope='business' which uses scope_id as the business context.
- `cursor` (query, string, optional) — Pagination cursor
- `limit` (query, integer, optional) — Page size

## Responses

### 200 — Successful Response

Schema: `NotificationListResponse`

- `items` (array · NotificationResponse · required) → `NotificationResponse`
  - `id` (string · required)
  - `recipient_kind` (RecipientKindEnum · required) → `RecipientKindEnum`
  - `recipient_id` (string · required)
  - `scope_business_id` (string)
  - `scope_firm_id` (string)
  - `source` (NotificationSourceEnum · required) → `NotificationSourceEnum`
  - `topic` (NotificationTopicEnum · required) → `NotificationTopicEnum`
  - `severity` (NotificationSeverityEnum · required) → `NotificationSeverityEnum`
  - `status` (NotificationStatusEnum · required) → `NotificationStatusEnum`
  - `snoozed_until` (string · date-time)
  - `pinned` (boolean)
  - `title` (string · required)
  - `body` (string)
  - `action_label` (string)
  - `action_url` (string)
  - `has_action` (boolean)
  - `attachments` (array · object)
  - `entity_type` (string)
  - `entity_id` (string)
  - `channels` (object)
  - `is_virtual` (boolean)
  - `expires_at` (string · date-time)
  - `metadata` (object)
  - `created_at` (string · date-time · required)
  - `updated_at` (string · date-time · required)
  - `status_changed_at` (string · date-time · required)
- `next_cursor` (string)
- `has_next` (boolean)

### 400 — Bad Request - Invalid input

### 401 — Unauthorized - Authentication required

### 403 — Forbidden - Insufficient permissions

### 422 — Validation Error

Schema: `HTTPValidationError`

- `detail` (array · ValidationError) → `ValidationError`
  - `loc` (array · string | integer · required)
  - `msg` (string · required)
  - `type` (string · required)
  - `input` (object)
  - `ctx` (object)

## Code samples

### cURL

```bash
curl -X GET 'https://api.ondayzero.com/api/v1/notifications' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID'
```

### JavaScript

```javascript
const response = await fetch('https://api.ondayzero.com/api/v1/notifications', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer dz_your_token',
    'x-business-id': 'YOUR_BUSINESS_ID',
  },
});
const data = await response.json();
```

### Python

```python
import httpx

headers = {
    "Authorization": "Bearer dz_your_token",
    "x-business-id": "YOUR_BUSINESS_ID",
}

response = httpx.get("https://api.ondayzero.com/api/v1/notifications", headers=headers)
data = response.json()
```

## See also

- HTML version: https://www.ondayzero.com/docs/reference/notifications/list-notifications
- OpenAPI slice: https://www.ondayzero.com/docs/reference/notifications/list-notifications/openapi.json
- Other endpoints in **notifications**: https://www.ondayzero.com/docs/reference/notifications