# GET /api/v1/attention

> List attention items

- **Tag:** attention
- **Operation ID:** `list_attention_api_v1_attention_get`

## 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: <business uuid>`.

## 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: `AttentionListResponse`

- `items` (array · AttentionItem · required) → `AttentionItem`
  - `id` (string · required) — Opaque identifier. Format: ``inbox:<uuid>`` for persistent messages or ``live:<alert_id>`` for computed signals.
  - `source` (AttentionSource · required) → `AttentionSource`
  - `category` (AttentionCategory · required) → `AttentionCategory`
  - `priority` (AttentionPriority · required) → `AttentionPriority`
  - `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`
  - `loc` (array · string | integer · required)
  - `msg` (string · required)
  - `type` (string · required)
  - `input` (object)
  - `ctx` (object)

## 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