Skip to content

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·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_requiredbooleandefault: False

Only show items requiring user action.

categorystring

Filter by category.

prioritystring

Filter by priority.

entity_typestring

Filter by entity type.

unread_onlybooleandefault: False

Hide read inbox messages and dismissed live alerts.

include_livebooleandefault: True

Include live (computed) alerts alongside inbox rows.

client_viewbooleandefault: False

If true, action URLs use the /client shell prefix instead of /books.

cursorstring

Inbox pagination cursor.

limitintegerdefault: 20

Max inbox items per page.

Responses

200Successful Response

successboolean
messagestring
codestring
dataAttentionListResponse

401Unauthorized - Missing or expired token, an MCP OAuth token used against the REST API, or no access to this business

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.

422Validation Error

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.