# Attention — DayZero API 6 endpoints. OpenAPI for just this tag: https://www.ondayzero.com/docs/reference/attention/openapi.json · HTML: https://www.ondayzero.com/docs/reference/attention · All tags: https://www.ondayzero.com/docs/reference/index.md ## Endpoints - `GET /api/v1/attention` — List attention items - `POST /api/v1/attention/clear-dismissals` — Restore dismissed live alerts - `POST /api/v1/attention/mark-all-read` — Mark all read + clear dismissals - `GET /api/v1/attention/summary` — Attention summary counts - `GET /api/v1/attention/{item_id}` — Get single attention item - `POST /api/v1/attention/{item_id}/read` — Mark item read or dismiss --- ## GET /api/v1/attention > List attention items - **Tag:** attention - **Operation ID:** `list_attention` ### Description 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. ### Authentication Bearer token in `Authorization` header. Required header: `x-business-id: `. ### Parameters - `action_required` (query, boolean, optional) — Only show items requiring user action. - `category` (query, string, optional) — Filter by category. - `priority` (query, string, optional) — Filter by priority. - `entity_type` (query, string, optional) — Filter by entity type. - `unread_only` (query, boolean, optional) — Hide read inbox messages and dismissed live alerts. - `include_live` (query, boolean, optional) — Include live (computed) alerts alongside inbox rows. - `client_view` (query, boolean, optional) — If true, action URLs use the ``/client`` shell prefix instead of ``/books``. - `cursor` (query, string, optional) — Inbox pagination cursor. - `limit` (query, integer, optional) — Max inbox items per page. ### Responses #### 200 — Successful Response Schema: `SuccessEnvelope_AttentionListResponse_` - `success` (boolean) - `message` (string) - `code` (string) - `data` (AttentionListResponse) #### 401 — Unauthorized - Missing or expired token, an MCP OAuth token used against the REST API, or no access to this business Schema: `ErrorResponse` - `error` (string · required) — Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`. - `message` (string · required) — Human-readable explanation, safe to show to end users. - `code` (string · required) — Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`). - `request_id` (string) — Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied. - `errors` (object) — Field-level validation messages keyed by field name. Present on 400/422 validation failures only. #### 422 — Validation Error Schema: `ErrorResponse` - `error` (string · required) — Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`. - `message` (string · required) — Human-readable explanation, safe to show to end users. - `code` (string · required) — Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`). - `request_id` (string) — Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied. - `errors` (object) — Field-level validation messages keyed by field name. Present on 400/422 validation failures only. ### Code samples #### cURL ```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 ```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 ```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() ``` ### See also - HTML version: https://www.ondayzero.com/docs/reference/attention/list-attention - OpenAPI slice: https://www.ondayzero.com/docs/reference/attention/list-attention/openapi.json - Other endpoints in **attention**: https://www.ondayzero.com/docs/reference/attention (markdown bundle: https://www.ondayzero.com/docs/reference/attention.md, OpenAPI: https://www.ondayzero.com/docs/reference/attention/openapi.json) - Endpoint catalog: https://www.ondayzero.com/docs/reference/index.md --- ## POST /api/v1/attention/clear-dismissals > Restore dismissed live alerts - **Tag:** attention - **Operation ID:** `clear_dismissals` ### Description Clears the user's per-user live alert dismissals. ### Authentication Bearer token in `Authorization` header. Required header: `x-business-id: `. ### Responses #### 201 — Successful Response Schema: `SuccessEnvelope_ClearAttentionDismissalsResponse_` - `success` (boolean) - `message` (string) - `code` (string) - `data` (ClearAttentionDismissalsResponse) #### 401 — Unauthorized - Missing or expired token, an MCP OAuth token used against the REST API, or no access to this business Schema: `ErrorResponse` - `error` (string · required) — Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`. - `message` (string · required) — Human-readable explanation, safe to show to end users. - `code` (string · required) — Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`). - `request_id` (string) — Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied. - `errors` (object) — Field-level validation messages keyed by field name. Present on 400/422 validation failures only. #### 422 — Validation Error Schema: `ErrorResponse` - `error` (string · required) — Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`. - `message` (string · required) — Human-readable explanation, safe to show to end users. - `code` (string · required) — Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`). - `request_id` (string) — Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied. - `errors` (object) — Field-level validation messages keyed by field name. Present on 400/422 validation failures only. ### Code samples #### cURL ```bash curl -X POST 'https://api.ondayzero.com/api/v1/attention/clear-dismissals' \ -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/attention/clear-dismissals', { method: 'POST', 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.post("https://api.ondayzero.com/api/v1/attention/clear-dismissals", headers=headers) data = response.json() ``` ### See also - HTML version: https://www.ondayzero.com/docs/reference/attention/clear-dismissals - OpenAPI slice: https://www.ondayzero.com/docs/reference/attention/clear-dismissals/openapi.json - Other endpoints in **attention**: https://www.ondayzero.com/docs/reference/attention (markdown bundle: https://www.ondayzero.com/docs/reference/attention.md, OpenAPI: https://www.ondayzero.com/docs/reference/attention/openapi.json) - Endpoint catalog: https://www.ondayzero.com/docs/reference/index.md --- ## POST /api/v1/attention/mark-all-read > Mark all read + clear dismissals - **Tag:** attention - **Operation ID:** `mark_all_read` ### Description Mark every inbox message read and clear all live alert dismissals so the bell shows zero. ### Authentication Bearer token in `Authorization` header. Required header: `x-business-id: `. ### Responses #### 201 — Successful Response Schema: `SuccessEnvelope_MarkAllAttentionReadResponse_` - `success` (boolean) - `message` (string) - `code` (string) - `data` (MarkAllAttentionReadResponse) #### 401 — Unauthorized - Missing or expired token, an MCP OAuth token used against the REST API, or no access to this business Schema: `ErrorResponse` - `error` (string · required) — Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`. - `message` (string · required) — Human-readable explanation, safe to show to end users. - `code` (string · required) — Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`). - `request_id` (string) — Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied. - `errors` (object) — Field-level validation messages keyed by field name. Present on 400/422 validation failures only. #### 422 — Validation Error Schema: `ErrorResponse` - `error` (string · required) — Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`. - `message` (string · required) — Human-readable explanation, safe to show to end users. - `code` (string · required) — Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`). - `request_id` (string) — Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied. - `errors` (object) — Field-level validation messages keyed by field name. Present on 400/422 validation failures only. ### Code samples #### cURL ```bash curl -X POST 'https://api.ondayzero.com/api/v1/attention/mark-all-read' \ -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/attention/mark-all-read', { method: 'POST', 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.post("https://api.ondayzero.com/api/v1/attention/mark-all-read", headers=headers) data = response.json() ``` ### See also - HTML version: https://www.ondayzero.com/docs/reference/attention/mark-all-read - OpenAPI slice: https://www.ondayzero.com/docs/reference/attention/mark-all-read/openapi.json - Other endpoints in **attention**: https://www.ondayzero.com/docs/reference/attention (markdown bundle: https://www.ondayzero.com/docs/reference/attention.md, OpenAPI: https://www.ondayzero.com/docs/reference/attention/openapi.json) - Endpoint catalog: https://www.ondayzero.com/docs/reference/index.md --- ## GET /api/v1/attention/summary > Attention summary counts - **Tag:** attention - **Operation ID:** `get_attention_summary` ### Description Counts used by the bell badge and the Action Items card. Combines unread inbox messages with live alert counts. ### Authentication Bearer token in `Authorization` header. Required header: `x-business-id: `. ### Parameters - `client_view` (query, boolean, optional) ### Responses #### 200 — Successful Response Schema: `SuccessEnvelope_AttentionSummary_` - `success` (boolean) - `message` (string) - `code` (string) - `data` (AttentionSummary) #### 401 — Unauthorized - Missing or expired token, an MCP OAuth token used against the REST API, or no access to this business Schema: `ErrorResponse` - `error` (string · required) — Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`. - `message` (string · required) — Human-readable explanation, safe to show to end users. - `code` (string · required) — Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`). - `request_id` (string) — Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied. - `errors` (object) — Field-level validation messages keyed by field name. Present on 400/422 validation failures only. #### 422 — Validation Error Schema: `ErrorResponse` - `error` (string · required) — Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`. - `message` (string · required) — Human-readable explanation, safe to show to end users. - `code` (string · required) — Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`). - `request_id` (string) — Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied. - `errors` (object) — Field-level validation messages keyed by field name. Present on 400/422 validation failures only. ### Code samples #### cURL ```bash curl -X GET 'https://api.ondayzero.com/api/v1/attention/summary' \ -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/attention/summary', { 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/attention/summary", headers=headers) data = response.json() ``` ### See also - HTML version: https://www.ondayzero.com/docs/reference/attention/get-attention-summary - OpenAPI slice: https://www.ondayzero.com/docs/reference/attention/get-attention-summary/openapi.json - Other endpoints in **attention**: https://www.ondayzero.com/docs/reference/attention (markdown bundle: https://www.ondayzero.com/docs/reference/attention.md, OpenAPI: https://www.ondayzero.com/docs/reference/attention/openapi.json) - Endpoint catalog: https://www.ondayzero.com/docs/reference/index.md --- ## GET /api/v1/attention/{item_id} > Get single attention item - **Tag:** attention - **Operation ID:** `get_attention_item` ### Description Fetch a single attention item (inbox or live) by its prefixed ID. Optionally marks it read/dismissed. ### Authentication Bearer token in `Authorization` header. Required header: `x-business-id: `. ### Parameters - `item_id` (path, string, required) - `auto_mark_read` (query, boolean, optional) - `client_view` (query, boolean, optional) ### Responses #### 200 — Successful Response Schema: `SuccessEnvelope_AttentionItem_` - `success` (boolean) - `message` (string) - `code` (string) - `data` (AttentionItem) #### 401 — Unauthorized - Missing or expired token, an MCP OAuth token used against the REST API, or no access to this business Schema: `ErrorResponse` - `error` (string · required) — Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`. - `message` (string · required) — Human-readable explanation, safe to show to end users. - `code` (string · required) — Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`). - `request_id` (string) — Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied. - `errors` (object) — Field-level validation messages keyed by field name. Present on 400/422 validation failures only. #### 404 — Not Found - Resource does not exist Schema: `ErrorResponse` - `error` (string · required) — Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`. - `message` (string · required) — Human-readable explanation, safe to show to end users. - `code` (string · required) — Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`). - `request_id` (string) — Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied. - `errors` (object) — Field-level validation messages keyed by field name. Present on 400/422 validation failures only. #### 422 — Validation Error Schema: `ErrorResponse` - `error` (string · required) — Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`. - `message` (string · required) — Human-readable explanation, safe to show to end users. - `code` (string · required) — Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`). - `request_id` (string) — Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied. - `errors` (object) — Field-level validation messages keyed by field name. Present on 400/422 validation failures only. ### Code samples #### cURL ```bash curl -X GET 'https://api.ondayzero.com/api/v1/attention/{item_id}' \ -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/attention/{item_id}', { 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/attention/{item_id}", headers=headers) data = response.json() ``` ### See also - HTML version: https://www.ondayzero.com/docs/reference/attention/get-attention-item - OpenAPI slice: https://www.ondayzero.com/docs/reference/attention/get-attention-item/openapi.json - Other endpoints in **attention**: https://www.ondayzero.com/docs/reference/attention (markdown bundle: https://www.ondayzero.com/docs/reference/attention.md, OpenAPI: https://www.ondayzero.com/docs/reference/attention/openapi.json) - Endpoint catalog: https://www.ondayzero.com/docs/reference/index.md --- ## POST /api/v1/attention/{item_id}/read > Mark item read or dismiss - **Tag:** attention - **Operation ID:** `mark_item_read` ### Description Mark an attention item read. Inbox items get ``read_at`` set; live alerts are dismissed for this user (until they clear dismissals). ### Authentication Bearer token in `Authorization` header. Required header: `x-business-id: `. ### Parameters - `item_id` (path, string, required) ### Responses #### 201 — Successful Response Schema: `SuccessEnvelope_MarkAttentionItemReadResponse_` - `success` (boolean) - `message` (string) - `code` (string) - `data` (MarkAttentionItemReadResponse) #### 401 — Unauthorized - Missing or expired token, an MCP OAuth token used against the REST API, or no access to this business Schema: `ErrorResponse` - `error` (string · required) — Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`. - `message` (string · required) — Human-readable explanation, safe to show to end users. - `code` (string · required) — Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`). - `request_id` (string) — Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied. - `errors` (object) — Field-level validation messages keyed by field name. Present on 400/422 validation failures only. #### 404 — Not Found - Resource does not exist Schema: `ErrorResponse` - `error` (string · required) — Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`. - `message` (string · required) — Human-readable explanation, safe to show to end users. - `code` (string · required) — Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`). - `request_id` (string) — Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied. - `errors` (object) — Field-level validation messages keyed by field name. Present on 400/422 validation failures only. #### 422 — Validation Error Schema: `ErrorResponse` - `error` (string · required) — Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`. - `message` (string · required) — Human-readable explanation, safe to show to end users. - `code` (string · required) — Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`). - `request_id` (string) — Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied. - `errors` (object) — Field-level validation messages keyed by field name. Present on 400/422 validation failures only. ### Code samples #### cURL ```bash curl -X POST 'https://api.ondayzero.com/api/v1/attention/{item_id}/read' \ -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/attention/{item_id}/read', { method: 'POST', 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.post("https://api.ondayzero.com/api/v1/attention/{item_id}/read", headers=headers) data = response.json() ``` ### See also - HTML version: https://www.ondayzero.com/docs/reference/attention/mark-item-read - OpenAPI slice: https://www.ondayzero.com/docs/reference/attention/mark-item-read/openapi.json - Other endpoints in **attention**: https://www.ondayzero.com/docs/reference/attention (markdown bundle: https://www.ondayzero.com/docs/reference/attention.md, OpenAPI: https://www.ondayzero.com/docs/reference/attention/openapi.json) - Endpoint catalog: https://www.ondayzero.com/docs/reference/index.md