/locations/{id}

Returns a Location object with the given id.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Path parameters

idstringRequiredformat: "uuid"

Headers

X-Account-TokenstringRequired
Token identifying the end user.

Query parameters

include_remote_databooleanOptional

Whether to include the original data Merge fetched from the third-party to produce these models.

include_shell_databooleanOptional

Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

remote_fieldsenumOptional

Deprecated. Use show_enum_origins.

Allowed values:
show_enum_originsenumOptional
A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
Allowed values:

Response

idstringRead-onlyformat: "uuid"
remote_idstring or null

The third-party API ID of the matching object.

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

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

location_typeenum or null
The location's type. Can be either WORK or HOME * `HOME` - HOME * `WORK` - WORK
Allowed values:
remote_was_deletedbooleanRead-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 nullRead-only
remote_datalist of objects or nullRead-only

Field support by integration

See all supported fields

Use the /linked-accounts endpoint to pull platform support information