List existing Worksites

Request

Returns a list with all existing Worksites for the authenticated Checkr account.

Worksites are read-only through the API: create and manage them from the Checkr Dashboard. Use the returned id as worksite_id when creating a Form I-9.

Security

basic_auth

Query

pageinteger

Specifies the page number to retrieve.

Default:1

per_pageinteger, <= 100

Indicates how many records each page should contain. The maximum is 100 records.

Default:20

curl -i -X GET \
  -u '<username>:<password>' \
  'https://docs.checkr.com/_mock/apis/openapi/v2/i9/worksites?page=1&per_page=20'

Responses

List of Worksites

Bodyapplication/json

objectstring

A list

Value:"list"

countinteger

Total number of records across all pages.

Example:1

next_hrefstring or null, (uri)

URL of the next page of results, or null on the last page.

Example:null

previous_hrefstring or null, (uri)

URL of the previous page of results, or null on the first page.

Example:null

dataArray of objects(I9Worksite)

Array of objects (Worksite)

Response

{
  "object": "list",
  "count": 1,
  "next_href": null,
  "previous_href": null,
  "data": [
    { … }
  ]
}