Skip to main content
GET
List all employers

Authorizations

Authorization
string
header
required

Username = api_key_id, Password = api_key_secret

Query Parameters

q
string

Free-text search filter.

kind
string

Filter by kind value.

mapping_status
string

Filter by mapping_status value.

Multiple mapping_status values can also be searched at once using either method:

  1. /v2/items?mapping_status=verified,mapped
  2. /v2/items?mapping_status=verified&mapping_status=mapped
status
string

Filter by status value.

Multiple status values can also be searched at once using either method:

  1. /v2/items?status=healthy,issues
  2. /v2/items?status=healthy&status=issues

Filtering by both healthy and issues will return all Items that currently support new payroll connections.

limit
integer<int32>

Number of Item objects returned per page. Default: 10. Maximum: 200.

Required range: 1 <= x <= 200
cursor
string

The URL returned in next or previous used to retrieve another page of results.

Response

200 - application/json
next
string<uri> | null

URL for the next page of results, if available.

previous
string<uri> | null

URL for the previous page of results, if available.

results
object[]