---
title: "Get the portal overview dashboard"
method: GET
path: "/overview"
tags: ["Company"]
---

# Get the portal overview dashboard

`GET /overview`

## Request

- Base URL: `https://api.app.lastaccountingcompany.com/portal`
- URL: `https://api.app.lastaccountingcompany.com/portal/overview`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/lastaccountingcompany/apis/lac-customer-api/docs/overview/get.ts> (a function with typed inputs; its response is checked against the schema)

One-call summary of the company's current state: the active period, headline metrics, items needing attention, filing readiness, connection health, import status, and document intake.

## Query parameters

- `customer_id` string

## Response `200`

Overview payload.

- PortalOverview: One-call summary of the company's current state.
  - `period` object
  - `metrics` object
  - `attention_items` object[]
  - `readiness` object
  - `connections` object
  - `imports` object
  - `intake` object

## Other responses

- `401`: Missing or invalid bearer token.
- `403`: Insufficient scope or role — e.g. a read-scoped key on a mutating method, or an API key on an admin/approver-only endpoint.

---

[API](https://skmtc.dev/lastaccountingcompany/apis/lac-customer-api.md) - [All operations](https://skmtc.dev/lastaccountingcompany/apis/lac-customer-api/llms.txt) - [OpenAPI document](https://skmtc.dev/lastaccountingcompany/apis/lac-customer-api/revisions/52e277b4f031?raw)
