---
title: "Customer Home insights card (accountant mirror)"
method: GET
path: "/accountant/companies/{customerId}/insights/home"
tags: ["Overview"]
---

# Customer Home insights card (accountant mirror)

`GET /accountant/companies/{customerId}/insights/home`

## Request

- Base URL: `https://api.medianfi.com/api/v1`
- URL: `https://api.medianfi.com/api/v1/accountant/companies/{customerId}/insights/home`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-Key`

Accountant-scoped mirror of `GET /companies/{companyId}/insights/home`. Same readiness gate as the customer surface (`available:false` with a reason until enough closed months exist). Entity scope is resolved from the customer's own entity roster (accountants hold no per-user entity grants): an explicit `entityId` must be one of the customer's concrete (non-group) entities; absent, the customer's single concrete entity is used; a multi-entity customer without `entityId` gets 422 ENTITY_SELECTION_REQUIRED and a customer with no entity gets 422 ENTITY_SCOPE_UNAVAILABLE.

## Query parameters

- `entityId` string, uuid

## Response `200`

Home-insights payload (same shape as the customer mount)

- HomeInsightsResponse
  - `success` true, required
  - `data` HomeInsightsData, required
    - `available` boolean, required
    - `reason` 'last_n_months_closed' | 'entity_scope_unavailable' | 'not_ready': Present only when available is false. last_n_months_closed: the insights-readiness gate's unmet requirement (recent months not closed). entity_scope_unavailable: an entityId was given but the company-wide recommendations cannot be honestly attributed to it (it is not the company's only non-group legal entity). not_ready: defensive fallback when readiness reports not-ready without naming a requirement.
    - `items` HomeInsightItem[], required: Empty when available is false; newest first.
      - `id` string, uuid, required
      - `category` string, required
      - `headline` string, required
      - `detail` string, required
      - `generatedAt` string, date-time, required: ISO timestamp the recommendation was generated.

## Other responses

- `401`: Authentication required
- `403`: Insufficient permissions or not a company member
- `404`: Unknown customer or an explicit entityId not belonging to the customer
- `422`: Request failed validation

---

[API](https://skmtc.dev/medianfi/apis/median-api.md) · [All operations](https://skmtc.dev/medianfi/apis/median-api/llms.txt) · [OpenAPI document](https://skmtc.dev/medianfi/apis/median-api/revisions/20090ea32b0d?raw)