Find site censuses

Find site censuses

GET /v3/site-censuses/finder

Find site censuses. Available for ≥ OpAdmins only.

Security

API_Key

searchstring, non-emptyrequired

Parameter to search for site censuses

pageinteger, >= 0

Number of results page of an endpoint with paginated results

Default:0

pageSizeinteger, [ 100 .. 1000 ]

Default:100

GET

/v3/site-censuses/finder

curl -i -X GET \
  'https://api.observepoint.com/v3/site-censuses/finder?search=string&page=0&pageSize=100' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Successful operation

Bodyapplication/json

metadataobjectrequired

Common metadata for iterable

itemsArray of objectsrequired

Response

{
  "metadata": {
    "pagination": { … }
  },
  "items": [
    { … }
  ]
}