Locations

Last Updated: August 27, 2018

Following is a list of the properties that belong to a location object, and a description of each.

id:
Integer. Read-only. Id of location.
addr1:
String. The first line of the location's address.
addr2:
String. The second line of the location's address.
city:
String. The city of the location's address.
state:
String. The state of the location's address.
zip:
String. The postal code of the location's address.
country:
String. The country of the location's address.
formatted_address:
String. Formatted address built from the objects addr1, addr2, city, state, and zip. Note: If the location doesn't contain addr1, addr2, or city properties than we default this value to the label prop.
active:
Boolean. If true, this location is active. If false, this location is archived.
latitude:
Decimal. The latitude of the location.
longitude:
Decimal. The longitude of the location.
place_id_hash:
String. The MD5 hash of the unique id for the location returned from the geocoding service.
label:
String. The formated name for the location. If the location was found using the geocode service the formated address will be saved in this field. Otherwise it will be what the user has named the location.
notes:
String. Notes related to the location (e.g. Use the back door.)
geocoding_status:
String. The geocoding status of this address. Will be one of: 'none', 'in_progress', 'retry', 'error', or 'complete'.
last_modified:
String (ISO8601 format). Read-only. Date/time when this location was last modified (e.g. 2004-02-12T15:19:21+00:00).
created:
String (ISO8601 format). Read-only. Date/time when this location was created (i.e. 2004-02-12T15:19:21+00:00).
linked_objects:
JSON object. Read-only. This is a key / value map of all the objects linked to this location and the corresponding object ids.
geofence_config_id:
Integer. Read-only. Id of the geofence_config associated with this location.