---
title: "Read the firm work summary cache"
method: GET
path: "/tally/work-summary"
tags: ["Tally"]
---

# Read the firm work summary cache

`GET /tally/work-summary`

## Request

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

Returns the firm's stored Work Summary snapshot for the current cache day (rolls at 05:00 firm local time) with a live day-activity overlay and revision freshness metadata. The default read does not rebuild. Pass refresh=1 for the one-release compatibility rebuild alias; prefer POST /tally/work-summary/refresh.

## Query parameters

- `refresh` '1'

## Response `200`

Live firm work summary

- object
  - `workSummary` object, required
    - `sample` boolean, required
    - `generatedAt` string, date-time, required
    - `generatedAtLabel` string, required
    - `timezone` string, required
    - `bankDate` string, required
    - `companyCount` integer, required
    - `narrative` string[], required
    - `partial` boolean
    - `sourceRevision` integer, required
    - `builtRevision` integer, nullable, required
    - `dirty` boolean, required
    - `refreshing` boolean, required
    - `changedAt` string, date-time, nullable
    - `liveCheckedAt` string, date-time, required
    - `refreshError` string, nullable
    - `heroes` object, required
    - `buckets` object, required
    - `needsYouItems` object[], required

## Other responses

- `default`: Error response

---

[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)
