Common ModelsLocations

The Location object

The Location object is used to represent an address that can be associated with an employee.

idstringOptionalRead-onlyformat: "uuid"
remote_idstring or nullOptional

The third-party API ID of the matching object.

created_atdatetimeOptionalRead-only
The datetime that this object was created by Merge.
modified_atdatetimeOptionalRead-only
The datetime that this object was modified by Merge.
namestring or nullOptional
The location's name.
phone_numberstring or nullOptional
The location's phone number.
street_1string or nullOptional
Line 1 of the location's street address.
street_2string or nullOptional
Line 2 of the location's street address.
citystring or nullOptional
The location's city.
statestring or nullOptional
The location's state. Represents a region if outside of the US.
zip_codestring or nullOptional
The location's zip code or postal code.
countryenum or nullOptional

The location’s country. The country code in ISO 3166-1 alpha-2 format.

location_typeenum or nullOptional

The location’s type. Can be either WORK or HOME

  • HOME - HOME
  • WORK - WORK
Allowed values:
remote_was_deletedbooleanOptionalRead-only

Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.

field_mappingsobject or nullOptionalRead-only
remote_datalist of objects or nullOptionalRead-only