List attention items

GET /api/v1/attention

Get the merged list of inbox messages and live alerts. Items are sorted with action-required first, then by priority, then newest first. Inbox messages support cursor pagination; live alerts are always returned in full on the first page.

Operation ID: list_attention_api_v1_attention_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

action_required boolean default: False: Only show items requiring user action.
category string: Filter by category.
priority string: Filter by priority.
entity_type string: Filter by entity type.
unread_only boolean default: False: Hide read inbox messages and dismissed live alerts.
include_live boolean default: True: Include live (computed) alerts alongside inbox rows.
client_view boolean default: False: If true, action URLs use the /client shell prefix instead of /books.
cursor string: Inbox pagination cursor.
limit integer default: 20: Max inbox items per page.

Responses

200 Successful Response

Schema: AttentionListResponse

items array · AttentionItem requiredAttentionItem

17 fields

id string required: Opaque identifier. Format: inbox:<uuid> for persistent messages or live:<alert_id> for computed signals.
source AttentionSource requiredAttentionSource
category AttentionCategory requiredAttentionCategory
priority AttentionPriority requiredAttentionPriority
title string required
body string: Optional longer description of the item.
icon string: Icon hint for the frontend (CSS icon name).
action_required boolean: Whether resolving this item requires user action. Items with action_required=True appear in the Action Items dashboard card; all items appear in the notification bell.
action_url string: In-app deep link the user should follow to resolve.
action_label string: Short label for the action button (e.g. 'Review').
entity_type string: Related entity kind, e.g. invoices, bills.
entity_id string: Related entity ID if applicable.
created_at string · date-time required
read boolean: True if the item is read (inbox) or has been dismissed by the user (live).
starred boolean: Inbox-only star state.
dismissible boolean: Whether the user can mark this read/dismiss. Always true for inbox; live items are dismissible per-user via user.props.
metadata object: Optional source-specific extra data.

next_cursor string

Inbox cursor for the next page (live items are not paginated).

has_more boolean

True if more inbox messages exist.

401 Unauthorized - Authentication required

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/attention

bash

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

javascript

const response = await fetch('https://api.ondayzero.com/api/v1/attention', {
  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/attention", headers=headers)
data = response.json()