List notifications

GET /api/v1/notifications

Get the caller's notification feed across all scopes

Operation ID: list_notifications_api_v1_notifications_get · View as markdown · OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Query

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

Responses

200 Successful Response

Schema: NotificationListResponse

items array · NotificationResponse requiredNotificationResponse

26 fields

id string required
recipient_kind RecipientKindEnum requiredRecipientKindEnum
recipient_id string required
scope_business_id string
scope_firm_id string
source NotificationSourceEnum requiredNotificationSourceEnum
topic NotificationTopicEnum requiredNotificationTopicEnum
severity NotificationSeverityEnum requiredNotificationSeverityEnum
status NotificationStatusEnum requiredNotificationStatusEnum
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

5 fields

loc array · string | integer required
msg string required
type string required
input object
ctx object

Code samples

GET /api/v1/notifications

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

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

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()