List existing Geos

Returns a list of existing Geos with the input name or state.

Security

basic_auth

namestring

Returns all Geos with the input name.

statestring

Returns all Geos with the input state.

pagenumber or null

Specifies the page number to retrieve.

per_pagenumber or null

Indicates how many records each page should contain. The default value is 25 records.

curl -i -X GET \
  -u '<username>:<password>' \
  'https://docs.checkr.com/_mock/apis/openapi/geos?name=string&state=string&page=0&per_page=0'

List of Geos

Bodyapplication/json

objectstring

A list

Value:"list"

next_hrefstring, (uri)

previous_hrefstring, (uri)

countinteger

Example:2

dataArray of objects(Geo)

Response

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