Skip to main content
GET
Get the payroll workspace

Authorizations

Authorization
string
header
required

Firebase ID token from an interactive portal session. Required for interactive operations (payroll, company settings, API-key management) and invoice decisions allowed by the member's review permissions.

Query Parameters

customer_id
string

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

period
string

Payroll period, YYYY-MM.

Response

Payroll workspace.

The payroll workspace for a period: employees, employer settings, and runs. Amounts are integer cents; rates are basis points. Interior shapes beyond the top level vary and are returned as-is.