List existing Schools

Returns a list of existing Schools for the input candidate_id.

Security

basic_auth

candidate_idstringrequired

Returns the list of schools for the input candidate_id.

curl -i -X GET \
  -u '<username>:<password>' \
  'https://docs.checkr.com/_mock/apis/openapi/candidates/{candidate_id}/schools'

List of Schools

Bodyapplication/json

dataArray of objects(School)

objectstring

A list

Value:"list"

next_hrefstring, (uri)

Response

{
  "data": [
    { … }
  ],
  "object": "list",
  "next_href": "http://example.com"
}