List notifications

GET/api/v1/notifications

Get the caller's notification feed across all scopes

Operation ID: list_notifications·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.

scopeNotificationScopeEnumdefault: me: Scope: 'me' (default), 'business', or 'firm'
scope_idstring: Required when scope is 'business' or 'firm'
statusarray · NotificationStatusEnum: Filter to one or more statuses
topicarray · NotificationTopicEnum: Filter to one or more topics
severityarray · NotificationSeverityEnum: Filter to one or more severities
include_terminalbooleandefault: False: Include resolved + dismissed rows
include_snoozedbooleandefault: False: Include snoozed rows whose timer hasn't elapsed
include_livebooleandefault: True: Merge live alerts (low cash, plaid stale, etc.) as virtual rows when a business context is available.
live_business_idstring: When scope='me', merge live alerts for this specific business id. Ignored for scope='business' which uses scope_id as the business context.
cursorstring: Pagination cursor
limitintegerdefault: 50: Page size

Schema: SuccessEnvelope_NotificationListResponse_

Schema: ErrorResponse

errorstringrequired: Error category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequired: Human-readable explanation, safe to show to end users.
codestringrequired: Stable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstring: Correlation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobject: Field-level validation messages keyed by field name. Present on 400/422 validation failures only.

Schema: ErrorResponse

errorstringrequired: Error category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequired: Human-readable explanation, safe to show to end users.
codestringrequired: Stable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstring: Correlation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobject: Field-level validation messages keyed by field name. Present on 400/422 validation failures only.

Schema: ErrorResponse

errorstringrequired: Error category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequired: Human-readable explanation, safe to show to end users.
codestringrequired: Stable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstring: Correlation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobject: Field-level validation messages keyed by field name. Present on 400/422 validation failures only.

Schema: ErrorResponse

errorstringrequired: Error category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequired: Human-readable explanation, safe to show to end users.
codestringrequired: Stable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstring: Correlation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobject: Field-level validation messages keyed by field name. Present on 400/422 validation failures only.

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'