---
title: "Firm-wide payroll overview from the cache"
method: GET
path: "/firm/payroll/overview"
tags: ["Payroll"]
---

# Firm-wide payroll overview from the cache

`GET /firm/payroll/overview`

## Request

- Base URL: `https://ledgerhq.pro/api/v1`
- URL: `https://ledgerhq.pro/api/v1/firm/payroll/overview`
- Auth: one of:
  - HTTP bearer and API key in header `x-organization-id`
  - HTTP bearer and API key in header `x-organization-id`

One row per accessible client company with its Gusto connection status, cached payroll record count, latest check date, employee count, latest payroll totals, and cache freshness. Read-only; no per-request Gusto calls. The firm's own books are never included.

## Response `200`

{companies:[...]}

---

[API](https://skmtc.dev/ledgerhq-pro/apis/ledgerhq-bookkeeping-api.md) · [All operations](https://skmtc.dev/ledgerhq-pro/apis/ledgerhq-bookkeeping-api/llms.txt) · [OpenAPI document](https://skmtc.dev/ledgerhq-pro/apis/ledgerhq-bookkeeping-api/revisions/9a8269f0a586?raw)