Sign in

v5

latestOpenAPI 3.1.02026-08-044697208.6 KB
Employers and Platforms

List Platforms

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

get/platforms

Query parameters

include_espsboolean

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.

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'payroll' | 'time_and_attendance' | 'tax' | 'merchant'

The type of the platform. payroll platforms are used for direct-deposit switching and for Verify use cases. time_and_attendance platforms contain data around shifts and hours. tax platforms are used for tax solutions. merchant type platforms are used for bill switching and cancellation.

The type of the platform. payroll platforms are used for direct-deposit switching and for Verify use cases. time_and_attendance platforms contain data around shifts and hours. tax platforms are used for tax solutions. merchant type platforms are used for bill switching and cancellation.

cursorstring

Cursor for the page you want to retrieve.

Cursor for the page you want to retrieve.

limitinteger

The maximum number of results to return.

The maximum number of results to return.

last_updatedstring date-time

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

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

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

OK

dataPlatformObjResponse[] required