List Accounts

get

https://api.getpinwheel.com/v1/accounts

List all payroll accounts. This is a paginated endpoint; see how Pinwheel implements pagination here.

Query Params

cursor

string

Cursor for the page you want to retrieve.

limit

integer

1 to 100

Defaults to 25

The maximum number of results to return.

connected

boolean

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

string

enum

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

Allowed:

Headers

Pinwheel-Version

string

enum

required

Defaults to 2022-03-02

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

Allowed:

Response

Language

Credentials

Header

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK