Skip to main content
Every business account can have multiple Locations. It is possible to grant access to staff to only one or multiple locations, and manage access levels on a per-location basis. Service settings such as lines or input fields are stored on a per-location basis.

​
Fields

NameTypeDescription
idnumberA unique ID for the Location
namestringThe location’s name.
latitudenumberThe location’s geographical latitude.
longitudenumberThe location’s geographical longitude.
countrystringWhich country the location’s located in.
addressstringThe location’s postal address.
selectingDeskMandatorybooleanTrue if clerks need to select a desk to start service, false if not.
timezoneOffsetnumberThe amount of minutes to add to UTC to get local time in this location. For example, if the timezoneOffset is -240, then the time zone for this location is UTC - 4 (EDT). This parameter follows daylight savings time.

​
Code examples

This is a Location object as provided by our RESTful API and our official libraries. 
{
  "id": 28594,
  "name": "White House",
  "latitude": 38.8976763,
  "longitude": -77.0365298,
  "country": "United States",
  "address": "1600 Pennsylvania Ave NW, Washington, DC 20500, United States",
  "selectingDeskMandatory": false,
  "timezoneOffset": -240
}