Locations
Retrieve Locations
Retrieving a single location is pretty straightforward. You'll just use the id
of locations to get it. When you are retrieving multiple locations, you can either request the full list of locations which will require pagination depending on how many locations you have available. If you just want a list of address or to check which locations a user has access to, you can pull from the cache, which will give you much faster results.
Retrieve LocationGET `/v1/locations/:location`
Get a single location using its id
.
List Locations
CacheGET `/v1/locations?cache=1`
You'll get all location cache objects without the need for pagination and much faster latency.
ExampleGET `/v1/locations`
When you want to retrieve multiple locations, your data
property on the result will always be an array
even if you don't have any locations.
Pagination
If the has_more
property on the pagination object is set to true, you know there are more locations in the database that have not been returned to you. The pagination object also has a page
property indicating your current offset and a limit property.
By default the page
is set to 1
and the limit
is 25
.
If we want to query for locations 26 - 50, we would request page 2 with a query parameter.