Platform Types
We now designate platforms with a type
, which can be one of two values: payroll
and time_and_attendance
. Almost all platforms are payroll
. The platforms that are designated time_and_attendance
are those that return shifts data but do not support payroll jobs such as direct_deposit_switch
and paystubs
. Platforms that support both shifts and payroll jobs are considered payroll
platforms.
On the list platforms endpoint, the optional type
query parameter can be used to list only platforms of the specified type. Only versions v2022-03-02
and after support this functionality.
On the list platforms endpoint, the type
response field is returned for each platform object. All versions support this functionality.
On the search endpoint, the optional platform_type
query parameter can be used to find only employers/platforms that support the specified type. Only versions v2022-03-02
and after support this functionality.
On the search endpoint, the platform_type
response field is returned for each search result object. All versions support this functionality.
On the create link token endpoint, the optional platform_type
can be added to the request body. This will cause Link to search only for employers/platforms of the specified type. All versions support this functionality.