Documentation Home

Locations

The Locations API allows people to retrieve info about locations.

GET

/locations

DESCRIPTION

Returns all locations, filtered by the 'locality' GET filter.

PARAMETERS

Parameter Type Required Description Values Default
locality GET Optional The locality to filter locations by. Any text NULL

RESPONSE

Type: application/json

A JSON object that complies with the JSON API standard (www.jsonapi.org).

Status Code Meaning
200 Successfully queried locations.
401 Invalid API key provided.
405 Invalid request HTTP method.

Example Success Response

GET

/locations/:location-id

DESCRIPTION

Returns info about the Location entity associated with the given ID.

PARAMETERS

Parameter Type Required Description Values Default
location-id URL_SLUG Required The ID of the Location entity to retrieve. Any positive integer NULL

RESPONSE

Type: application/json

A JSON object that complies with the JSON API standard (www.jsonapi.org).

Status Code Meaning
200 Successfully queried specified location.
401 Invalid API key provided.
404 No location was found for the provided ID.
405 Invalid request HTTP method.

Example Success Response