Search Employers and Platforms

get

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

Search all employers and platforms supported by Link.

Query Params

string

required

length ≥ 1

Search query on the employer/platform name.

supported_jobs

array of strings

Filter on supported jobs. Multiple keys are allowed. May be expanded to include new enum values (see our Change Management policy).

supported_jobs

Allowed:

response_types

array of strings

Filter on response type. Multiple keys are allowed. May be expanded to include new enum values (see our Change Management policy).

response_types

Allowed:

amount_supported

boolean

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.

platform_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:

limit

integer

1 to 100

Defaults to 25

The maximum number of results to return.

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

Loading…

Response

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

application/json

200OK