GET Locations
Changed on/locations Permission level: 7
get/locations
Request
- Base URLhttps://www.humanity.com/api/v2
- AuthAPI key in query parameter access_token
Query parameters
typeinteger
enum[1,2] -> 1: Location; 2: Remote sites
updated_atstring date
DateTime in ISO8601 format. <br> Retrieves only locations that were updated <strong>after</strong> the date and time provided with this parameter.
include_deletedinteger
enum[0,1] -> 0: Do not Include deleted locations; 1: Include deleted locations
filter[id]string
Filters response by location ids. Those ids should be coma separated.
filter[only_primary]integer
Response will return only primary location if this is set to 1.
filter[include_primary]integer
By default, primary location is excluded from response. It can be included by setting the value to 1.
Response
200
Example response
{
"status": 1,
"data": [
{
"id": 542311,
"name": "Dream Coffee Shop 2",
"country": "NL",
"address": "Wijde Heisteeg 4, 1016 AS Amsterdam, Netherlands",
"lat": 52.3687499,
"lon": 4.8875525,
"store": 251300,
"type": 1,
"timezone_id": 311,
"map": "https://maps.google.com/maps?f=q&source=s_q&hl=en&geocode=&q=Wijde+Heisteeg+4%2C+1016+AS+Amsterdam%2C+Netherlands%2C+NL",
"directions": "https://maps.google.com/maps?f=q&source=s_q&hl=en&geocode=&q=Wijde+Heisteeg+4%2C+1016+AS+Amsterdam%2C+Netherlands%2C+NL"
}
],
"token": "xxxxxxx"
}Changes
- info
endpoint added
- info