Locations

Retrieve a location

This endpoint returns a single location on a map when provided a valid location id. Example Request:

curl --location 'https://api.mapulus.com/api/v1/locations/<location-id>' \
--header 'Authorization: Bearer <your-token>' \

get/api/v1/locations/{id}

Request

Base URL: https://api.mapulus.com
URL: https://api.mapulus.com/api/v1/locations/{id}
Auth: HTTP bearer

Path parameters

idstring required

Location ID (Required)

Response

Success: Returns single location.

objectstring required

idstring uuid required

latnumber float nullable required

lonnumber float nullable required

labelstring nullable

titlestring nullable

addressstring nullable

external_idstring nullable

geocoding_errorboolean nullable

geocoding_error_typestring nullable

created_atstring date-time required

updated_atstring date-time required

travel_contourboolean nullable

contour_modestring nullable

contour_metricstring nullable

contour_stylestring nullable

contour_minutesstring nullable

map_idstring uuid required

layer_idstring uuid required

Example response

{
  "object": "location",
  "lat": -27.4704528,
  "lon": 153.0260341,
  "title": "Head Office",
  "address": "Brisbane, Australia",
  "contour_mode": "driving",
  "contour_metric": "minutes",
  "contour_style": "polygons",
  "contour_minutes": "15",
  "custom_attributes": [
    {
      "object": "custom_attribute",
      "name": "Location Type",
      "value": "Public Store"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.