Communities

List of all communities

Returns a list of all communities

A comma separated list of tag:value search parameters, a colon separator performs an exact match, a percent separator performs a starts-with search and a greater/less than separator searches number/date ranges.

Request
query Parameters
q
string <string>

Filter by any community value,

Example: q=name%Student
Responses
200

List of communities

403

Access denied to resource

404

Resource not found

500

Internal server error

get/community
Request samples
curl -i -X GET \
  'https://api.whosonlocation.com/v1/community?q=string'
Response samples
application/json
application/json
application/xml
[
  • {
    }
]

Retrieve a community

Retrieves a single community, filtering with the provided ID.

Request
path Parameters
id
required
integer <int32>

ID of the community to retrieve

Responses
200
403

Access denied to resource

404

Resource not found

500

Internal server error

get/community/{id}
Request samples
curl -i -X GET \
  https://api.whosonlocation.com/v1/community/:id
Response samples
application/json
application/json
application/xml
{
  • "id": 1206,
  • "created": "2021-11-26T14:35:28+13:00",
  • "modified": "2021-12-31T14:35:28+13:00",
  • "name": "Students",
  • "active": true,
  • "is_evac_enabled": true,
  • "evac_primary_filter": "name"
}