Employers and Platforms
Get Platform
Get a payroll platform supported by Link.
get/platforms/{platform_id}
Request
- Base URLhttps://api.getpinwheel.com/v1
- AuthAPI key in header X-API-SECRET
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
platform_idstring uuid required
UUID of the platform.
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
Changes
No recorded changes to this operation across all 13 revisions of this API.