---
title: "Get the payroll workspace"
method: GET
path: "/payroll"
tags: ["Payroll"]
---

# Get the payroll workspace

`GET /payroll`

## Request

- Base URL: `https://api.app.lastaccountingcompany.com/portal`
- URL: `https://api.app.lastaccountingcompany.com/portal/payroll`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/lastaccountingcompany/apis/lac-customer-api/docs/payroll/get.ts> (a function with typed inputs; its response is checked against the schema)

NOT available to API keys — requires an interactive admin/approver session. Returns the payroll workspace for a period (`YYYY-MM`, default current): employees, employer settings, draft/approved runs. Amounts are integer cents; rates are basis points.

## Query parameters

- `customer_id` string
- `period` string

## Response `200`

Payroll workspace.

- PayrollWorkspaceData: 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.

## Other responses

- `401`: Missing or invalid bearer token.
- `403`: Insufficient scope or role — e.g. a read-scoped key on a mutating method, or an API key on an admin/approver-only endpoint.

---

[API](https://skmtc.dev/lastaccountingcompany/apis/lac-customer-api.md) - [All operations](https://skmtc.dev/lastaccountingcompany/apis/lac-customer-api/llms.txt) - [OpenAPI document](https://skmtc.dev/lastaccountingcompany/apis/lac-customer-api/revisions/52e277b4f031?raw)