v1

latestOpenAPI 3.1.02026-07-22733584.5 KB
Company

Get the portal overview dashboard

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.

get/overview

Query parameters

customer_idstring

Target company. Optional — API keys are pinned to one company, and single-company sessions default to it.

Response

Overview payload.

periodobject
metricsobject
attention_itemsobject[]
readinessobject
connectionsobject
importsobject
intakeobject