List Platforms

get

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

List all payroll platforms supported by Link. This is a paginated endpoint; see how Pinwheel implements pagination here.

Query Params

include_esps

boolean

Defaults to false

ESP (employer-specific platform) is a term that is used to describe an Employer that uses a unique, dedicated payroll portal to serve their employees. Eg. - Walmart employees will authenticate via a Walmart payroll portal, whereas employees at Hilton will authenticate via ADP. ESPs can be thought of as both employers and platforms, so you can use this flag to include ESPs in the set of supported payroll platforms if desired.

type

string

enum

If included, filters results by the platform type. Platforms are either payroll or time_and_attendance. Most platforms are payroll. Payroll platforms support operations such as updating direct deposit allocation settings. Time & Attendance platforms contain data around shifts and hours worked, but do not support payroll operations.

Allowed:

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.

last_updated

date-time

Filter for results updated more recently than last_updated. ISO 8601 timestamp.

Headers

Pinwheel-Version

string

enum

required

Defaults to 2022-09-09

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

Allowed:

Response

Language

Credentials

Header

URL

Loading…

Response

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

application/json

200OK