Search Employers and Platforms
Changed onSearch all employers and platforms supported by Link.
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.
Query parameters
Search query on the employer/platform name.
Filter on supported jobs. Multiple keys are allowed. May be expanded to include new enum values (see our Change Management policy).
Filter on response type. Multiple keys are allowed. May be expanded to include new enum values (see our Change Management policy).
Filter on amount_supported. If true, results that support setting a specific dollar amount for direct deposit switches will be returned. If false, results that support setting a specific dollar amount for direct deposit switches will be excluded.
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 maximum number of results to return.
Headers
Version identifier specifying how the Pinwheel API should behave. See the Change Management page for more information.
Response
OK
Changes
- info
added the optional property
//to the response with the status
- info
- breaking
removed the enum value
paycheck_viewerfrom the propertyitems/of thequeryrequest parametersupported_jobs - info
removed the
paycheck_viewerenum value from the///response property for the response status
- breaking