Location API Reference Overview Follow

This article describes the uses of the top-level Locations API resource. It builds on concepts discussed in the REST API Overview.

REST Resources

The Locations resource contains Location-specific information. You can use this resource to get a list of Locations a specific user can access.

/api/locations

The Locations resource will return data for the Locations to which your token has access, but you may find it more useful to use a specific Location ID.

/api/locations/{location_id}

Organization Detail

Making a request to the Location resource will return details about the Location and the Location’s Organization. The Organization detail information includes the Organization name and ID, when it was created, when it was last modified, and other organization-specific information. For more information, read the Organization API Resource.

Location Detail

The location detail information includes the location name and ID, when it was created, when it was last modified, and other location-specific information, such as if the data of the location is "published" for use by the SDKs.

It also includes a list of the features that are enabled for the location.

Location detail also includes mapping information, such as the location’s latitude and longitude, its time zone, and the default language.

You can find a 'Search Examples' field in the Location detail, which is used to show suggestions to a user requesting directions without Blue Dot.

Related Resources

The Locations endpoint is the top level endpoint for the following endpoints:

• Beacons
• Maps
• Placemarks
• Search