Accounts

List Accounts

List all payroll accounts. This is a paginated endpoint; see how Pinwheel implements pagination <a href='https://docs.pinwheelapi.com/docs/pagination-1' target='_blank'>here</a>.

get/accounts

Request

Base URL
https://api.getpinwheel.com/v1
Auth
API key in header X-API-SECRET
TypeScript
https://skmtc.dev/getpinwheel/apis/pinwheel/docs/accounts/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

cursorstring

Cursor for the page you want to retrieve.

limitinteger

The maximum number of results to return.

connectedboolean

If included, filter on connected accounts. If true, return only accounts that are connected. If false, return only accounts that are disconnected. Connected accounts are accounts for which you can retrieve new data manually using On Demand Updates or automatically via Monitoring.

monitoring_status'active' | 'degraded' | 'user_action_required' | 'customer_disabled' | 'unavailable'

Monitoring status describes the the automated ability of Pinwheel to retrieve new account information.

Headers

Pinwheel-Version'2025-07-08' | '2023-11-22' | '2023-07-18' | '2023-04-18' | '2022-09-09' | '2022-06-22' | '2022-03-02' required

Version identifier specifying how the Pinwheel API should behave. See the Change Management page for more information.

Response

dataPayrollAccountObjResponse[] required

Changes

No recorded changes to this operation across all 13 revisions of this API.