Retrieve data for multiple locations with a GET request to the endpoint.
The search query can match the name or address of the location. Omitting the search query will return all locations. The response body will contain the location data as a JSON array.
A search can also be performed by geographic coordinates:
curl -u '[email protected]:{password}' https://www.keycafe.com/v0/location?latitude=9.2839043&longitude=-123.1053527&minimumHours=140 -H "Accept: application/json"| latitude | Required. The latitude around which to search for nearby locations. |
| longitude | Required. The longitude around which to search for nearby locations. |
| minimumHours | The minimum number of hours the location must be open every week to be returned. |
The results will be sorted by distance, and each location object will include its distance in kilometers from the specified coordinates:
[
{ "name": "Corner Cafe", "distance": 3, ... },
{ "name": "Another Cafe", "distance": 5, ... }
]A search can also be performed using a geographic bounding box:
curl -u '[email protected]:{password}' https://www.keycafe.com/v0/location?northEastLat=9.2839043&northEastLng=-123.1053527&southWestLat=9.2839043&southWestLng=-123.1053527 -H "Accept: application/json"| northEastLat | Required. The latitude of the north east corner of the bounds. |
| northEastLng | Required. The longitude of the north east corner of the bounds. |
| southWestLat | Required. The latitude of the south west corner of the bounds. |
| southWestLng | Required. The longitude of the south west corner of the bounds. |
A search can also be filtered to include only locations where the authenticated user has an access:
curl -u '[email protected]:{password}' https://www.keycafe.com/v0/location?access=true -H "Accept: application/json"| access | Required. True if only locations where the authenticated user has an access should be included. |
A search can also be performed by postal code:
curl -u '[email protected]:{password}' https://www.keycafe.com/v0/location?country=Canada&postalCode=A1A1A1 -H "Accept: application/json"| country | Required. The country in which to search for locations. |
| postalCode | Required. The postal code in which to search for locations. In Canada and the UK, this matches the first 3 characters only. |
| minimumHours | The minimum number of hours the location must be open every week to be returned. |
[
{ "name": "Corner Cafe", ... },
{ "name": "Another Cafe", ... }
]A search can also be filtered to include only private locations (enterprise customers only):
curl -u '[email protected]:{password}' https://www.keycafe.com/v0/location?private=true -H "Accept: application/json"A search can also be performed by organization ID. The results will include all locations belonging to the specified organization.
curl -u '[email protected]:{password}' https://www.keycafe.com/v0/location?organization=123456 -H "Accept: application/json"Results are limited to 5 per page, with additional pages available via the Link response header:
Link: <https://www.keycafe.com/v0/location?query=vancouver&page=2>; rel="next", <https://www.keycafe.com/v0/location?query=vancouver&page=5>; rel="last"