Skip to content

Latest commit

 

History

History
26 lines (18 loc) · 1.56 KB

Location.md

File metadata and controls

26 lines (18 loc) · 1.56 KB

Location

The Location Object ### Description The Location object is used to represent a Location for a Company or Employee address. This is shared across many models and is referenced whenever a location is stored. ### Usage Example Fetch from the LIST Locations endpoint and filter by ID to show all office locations.

Properties

Name Type Description Notes
id UUID [optional] [readonly]
remoteId String The third-party API ID of the matching object. [optional]
name String The location's name. [optional]
phoneNumber String The location's phone number. [optional]
street1 String Line 1 of the location's street address. [optional]
street2 String Line 2 of the location's street address. [optional]
city String The location's city. [optional]
state String The location's state. Represents a region if outside of the US. [optional]
zipCode String The location's zip code or postal code. [optional]
country CountryEnum The location's country. [optional]
locationType LocationTypeEnum The location's type. Can be either WORK or HOME [optional]
remoteData List<RemoteData> [optional] [readonly]
remoteWasDeleted Boolean Indicates whether or not this object has been deleted on the third-party. [optional] [readonly]