Added Payroll Digests API for multi-company payroll monitoring

The new Payroll Digests API lets partners retrieve payroll state summaries across many companies in a single asynchronous request, returning statuses, blockers, pay periods, and totals for up to 25 companies per batch.

Why this matters

Partners building accountant dashboards, bookkeeper tools, and ops monitoring views previously had to fan out per-company calls to assemble a cross-portfolio view of upcoming payrolls. That pattern is slow, hits rate limits, and makes it hard to surface "what needs attention this week" across a book of business. The Payroll Digests API consolidates that work into one async submission you poll for results, so you can render a portfolio-wide payroll status view without orchestrating dozens of parallel requests.

Key functionality

• Submit up to 25 company UUIDs per batch and receive consolidated payroll state for each one
• Asynchronous request pattern—POST to submit, then GET to poll for results (mirrors the People Batch API)
• Returns payroll statuses, blockers, pay period details, and payroll totals per company
• Fixed reporting window covers roughly the last 7 days through the next 30 days
• Idempotent submissions via the idempotency_key field, so safe retries won't create duplicate batches
• Partial success handling—companies that can't be processed appear in exclusions with a reason, while successful companies appear in results
• Uses a system-level access token rather than per-company tokens, so a single call covers the whole portfolio

New endpoints

• POST /v1/payroll_digests—submit a batch of company UUIDs and receive a digest UUID to poll
• GET /v1/payroll_digests/{payroll_digest_uuid}—retrieve the results of a submitted batch

New OAuth scopes

• payroll_digests:read
• payroll_digests:write

These scopes are gated. Contact your Gusto representative to have them enabled on your application before integrating.

Get started

See the full Payroll Digests API guide for request and response examples, polling guidance, and recommendations on handling exclusions.