REST API

As of version 3.8.1, Locatoraid provides a number of REST API endpoints to query and update its locations database.

To enable these REST API functions, you will need to activate a separate plugin called Locatoraid REST which is shipped with the main plugin package.

List locations

GET /locatoraid/v3/locations

Arguments

page
per_page
search

Examples

GET https://www.yoursite.com/wp-json/locatoraid/v3/locations

GET https://www.yoursite.com/wp-json/locatoraid/v3/locations?page=2&per_page=100

GET https://www.yoursite.com/wp-json/locatoraid/v3/locations?search=helsinki

Retrieve a location

GET /locatoraid/v3/locations/<id>

Examples

GET https://www.yoursite.com/wp-json/locatoraid/v3/locations/<id>

Delete a location

DELETE /locatoraid/v3/locations/<id>

Headers

X-WP-Locatoraid-AuthCode [required]

Examples

DELETE https://www.yoursite.com/wp-json/locatoraid/v3/locations/<id>

Create a location

POST /locatoraid/v3/locations

Headers

X-WP-Locatoraid-AuthCode [required]

Arguments

name
street1
street2
city
state
zip
country
phone
website
latitude
longitude

Examples

POST https://www.yoursite.com/wp-json/locatoraid/v3/locations