Location
The Location resource encompasses the geographical details of an address associated with a contact. It includes information such as formatted address, country, state, city, town, postal code, latitude, and longitude. Additionally, the what3words resource, nested within Location, provides geocoding information using What3words, where What3words is enabled.
Events
The following events are available for locations:
| Event Type | Description |
|---|---|
location.created | Triggered when a new location is added to an incident |
location.updated | Triggered when any location information is modified |
location.deleted | Triggered when a location is removed from an incident |
The location object
Attributes
- objectstring
Type of the location, always "Location".
- idstring
Unique identifier for the location.
- formatted_addressstring or null
Formatted address.
- address_linestring or null
First line of the address.
- address_line2string or null
Second line of the address.
- countrystring or null
Country of the location.
- statestring or null
State of the location.
- citystring or null
City of the location.
- townstring or null
Town of the location.
- postal_codestring or null
Postal code of the location.
- latitudenumber or null
Latitude of the location.
- longitudenumber or null
Longitude of the location.
- what3wordsobject or null
What3Words information for the location.
Show child attributes
- what3words.countrystring or null
Country for What3Words.
- what3words.squareobject or null
Square information for What3Words.
Show child attributes
Southwest coordinates in the square.
Show child attributes
Longitude coordinate.
Latitude coordinate.
Northeast coordinates in the square.
Show child attributes
Longitude coordinate.
Latitude coordinate.
- what3words.nearestPlacestring or null
Nearest place for What3Words.
- what3words.coordinatesobject or null
Coordinates information for What3Words.
Show child attributes
Longitude coordinate.
Latitude coordinate.
- wordsstring or null
Words information for What3Words.
- mapstring or null
Map information for What3Words.
interface Location {
object: "Address";
id: string;
formatted_address: string | null;
address_line: string | null;
address_line2: string | null;
country: string | null;
state: string | null;
city: string | null;
town: string | null;
postal_code: string | null;
latitude: number | null;
longitude: number | null;
what3words: W3w | null;
}