/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

idstring or nullRead-onlyformat: "uuid"
remote_idstring or null

The third-party API ID of the matching object.

created_atdatetime or nullRead-only
The datetime that this object was created by Merge.
modified_atdatetime or nullRead-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. * `AF` - Afghanistan * `AX` - Åland Islands * `AL` - Albania * `DZ` - Algeria * `AS` - American Samoa * `AD` - Andorra * `AO` - Angola * `AI` - Anguilla * `AQ` - Antarctica * `AG` - Antigua and Barbuda * `AR` - Argentina * `AM` - Armenia * `AW` - Aruba * `AU` - Australia * `AT` - Austria * `AZ` - Azerbaijan * `BS` - Bahamas * `BH` - Bahrain * `BD` - Bangladesh * `BB` - Barbados * `BY` - Belarus * `BE` - Belgium * `BZ` - Belize * `BJ` - Benin * `BM` - Bermuda * `BT` - Bhutan * `BO` - Bolivia * `BQ` - Bonaire, Sint Eustatius and Saba * `BA` - Bosnia and Herzegovina * `BW` - Botswana * `BV` - Bouvet Island * `BR` - Brazil * `IO` - British Indian Ocean Territory * `BN` - Brunei * `BG` - Bulgaria * `BF` - Burkina Faso * `BI` - Burundi * `CV` - Cabo Verde * `KH` - Cambodia * `CM` - Cameroon * `CA` - Canada * `KY` - Cayman Islands * `CF` - Central African Republic * `TD` - Chad * `CL` - Chile * `CN` - China * `CX` - Christmas Island * `CC` - Cocos (Keeling) Islands * `CO` - Colombia * `KM` - Comoros * `CG` - Congo * `CD` - Congo (the Democratic Republic of the) * `CK` - Cook Islands * `CR` - Costa Rica * `CI` - Côte d'Ivoire * `HR` - Croatia * `CU` - Cuba * `CW` - Curaçao * `CY` - Cyprus * `CZ` - Czechia * `DK` - Denmark * `DJ` - Djibouti * `DM` - Dominica * `DO` - Dominican Republic * `EC` - Ecuador * `EG` - Egypt * `SV` - El Salvador * `GQ` - Equatorial Guinea * `ER` - Eritrea * `EE` - Estonia * `SZ` - Eswatini * `ET` - Ethiopia * `FK` - Falkland Islands (Malvinas) * `FO` - Faroe Islands * `FJ` - Fiji * `FI` - Finland * `FR` - France * `GF` - French Guiana * `PF` - French Polynesia * `TF` - French Southern Territories * `GA` - Gabon * `GM` - Gambia * `GE` - Georgia * `DE` - Germany * `GH` - Ghana * `GI` - Gibraltar * `GR` - Greece * `GL` - Greenland * `GD` - Grenada * `GP` - Guadeloupe * `GU` - Guam * `GT` - Guatemala * `GG` - Guernsey * `GN` - Guinea * `GW` - Guinea-Bissau * `GY` - Guyana * `HT` - Haiti * `HM` - Heard Island and McDonald Islands * `VA` - Holy See * `HN` - Honduras * `HK` - Hong Kong * `HU` - Hungary * `IS` - Iceland * `IN` - India * `ID` - Indonesia * `IR` - Iran * `IQ` - Iraq * `IE` - Ireland * `IM` - Isle of Man * `IL` - Israel * `IT` - Italy * `JM` - Jamaica * `JP` - Japan * `JE` - Jersey * `JO` - Jordan * `KZ` - Kazakhstan * `KE` - Kenya * `KI` - Kiribati * `KW` - Kuwait * `KG` - Kyrgyzstan * `LA` - Laos * `LV` - Latvia * `LB` - Lebanon * `LS` - Lesotho * `LR` - Liberia * `LY` - Libya * `LI` - Liechtenstein * `LT` - Lithuania * `LU` - Luxembourg * `MO` - Macao * `MG` - Madagascar * `MW` - Malawi * `MY` - Malaysia * `MV` - Maldives * `ML` - Mali * `MT` - Malta * `MH` - Marshall Islands * `MQ` - Martinique * `MR` - Mauritania * `MU` - Mauritius * `YT` - Mayotte * `MX` - Mexico * `FM` - Micronesia (Federated States of) * `MD` - Moldova * `MC` - Monaco * `MN` - Mongolia * `ME` - Montenegro * `MS` - Montserrat * `MA` - Morocco * `MZ` - Mozambique * `MM` - Myanmar * `NA` - Namibia * `NR` - Nauru * `NP` - Nepal * `NL` - Netherlands * `NC` - New Caledonia * `NZ` - New Zealand * `NI` - Nicaragua * `NE` - Niger * `NG` - Nigeria * `NU` - Niue * `NF` - Norfolk Island * `KP` - North Korea * `MK` - North Macedonia * `MP` - Northern Mariana Islands * `NO` - Norway * `OM` - Oman * `PK` - Pakistan * `PW` - Palau * `PS` - Palestine, State of * `PA` - Panama * `PG` - Papua New Guinea * `PY` - Paraguay * `PE` - Peru * `PH` - Philippines * `PN` - Pitcairn * `PL` - Poland * `PT` - Portugal * `PR` - Puerto Rico * `QA` - Qatar * `RE` - Réunion * `RO` - Romania * `RU` - Russia * `RW` - Rwanda * `BL` - Saint Barthélemy * `SH` - Saint Helena, Ascension and Tristan da Cunha * `KN` - Saint Kitts and Nevis * `LC` - Saint Lucia * `MF` - Saint Martin (French part) * `PM` - Saint Pierre and Miquelon * `VC` - Saint Vincent and the Grenadines * `WS` - Samoa * `SM` - San Marino * `ST` - Sao Tome and Principe * `SA` - Saudi Arabia * `SN` - Senegal * `RS` - Serbia * `SC` - Seychelles * `SL` - Sierra Leone * `SG` - Singapore * `SX` - Sint Maarten (Dutch part) * `SK` - Slovakia * `SI` - Slovenia * `SB` - Solomon Islands * `SO` - Somalia * `ZA` - South Africa * `GS` - South Georgia and the South Sandwich Islands * `KR` - South Korea * `SS` - South Sudan * `ES` - Spain * `LK` - Sri Lanka * `SD` - Sudan * `SR` - Suriname * `SJ` - Svalbard and Jan Mayen * `SE` - Sweden * `CH` - Switzerland * `SY` - Syria * `TW` - Taiwan * `TJ` - Tajikistan * `TZ` - Tanzania * `TH` - Thailand * `TL` - Timor-Leste * `TG` - Togo * `TK` - Tokelau * `TO` - Tonga * `TT` - Trinidad and Tobago * `TN` - Tunisia * `TR` - Turkey * `TM` - Turkmenistan * `TC` - Turks and Caicos Islands * `TV` - Tuvalu * `UG` - Uganda * `UA` - Ukraine * `AE` - United Arab Emirates * `GB` - United Kingdom * `UM` - United States Minor Outlying Islands * `US` - United States of America * `UY` - Uruguay * `UZ` - Uzbekistan * `VU` - Vanuatu * `VE` - Venezuela * `VN` - Vietnam * `VG` - Virgin Islands (British) * `VI` - Virgin Islands (U.S.) * `WF` - Wallis and Futuna * `EH` - Western Sahara * `YE` - Yemen * `ZM` - Zambia * `ZW` - Zimbabwe
location_typeenum or null
The location's type. Can be either WORK or HOME * `HOME` - HOME * `WORK` - WORK
Allowed values:
remote_was_deletedboolean or nullRead-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](https://docs.merge.dev/integrations/hris/supported-features/).
field_mappingsobject or nullRead-only
remote_datalist of objects or nullRead-only
<MergeSupportedFieldsByIntegrationWidget requestType="GET" data="H4sIAAAAAAAAA+1dbVPiyBb+K6l8utdCURnX0apbtxQUUIkM4N6d2ZpKNckhtHS6Y6cjwtb+91udF8RZa3eQE0ic+SSG8CQ8zzmnT/c5af4wHaLAE3JmnppjSUOzYvrCBWaemjfCIYoKblZMElCL+JCeYz8emhUzjIJASAXuJQXmhi0JI/PUrPogPdiNOB1RcKv69CrlCjwZY4XVxcd2R/HnzIrJKJ+Ae+Y4IuLq74CSE3dJcuY3/+q3Q2VWzICEoRpLEXnjHjxEEP4tpr4fBj5wRdiuSxSpLn1+VyYArx3Td+4CAwVugyjSAAWO/orptcZKBeFptToGFuzF191z4bEKvEqkog6DsHpUOzk8PjnaTVHiq//X9th/DnbuH4ZieLxjew6zSbTTGThP1qA9te69D1b9w5M1vzuy5pO5dT/Z37E9stMZdI5uB59rt42zg9tXTrD7v/x28ut54/zK2nHmFzXr/vPUGjgHnYEzGc7btaumM71qfXqy5p8PO427mjW4OLpqioPbei/s1Huic7a3Z1bMZSXN09//WD6QGshxOKajmJyl99o+8WCJlEQHEtDdIBoy6uyFtT3ik7ngZBruOcKv+uBSUu0yokZC+imo3ZUiAKlm9mH7Gfz5aK3/EBEJzwc+PL86OPpoh/HbewH3Mu2o4AvhzFPzwmqdWfWLxksrOnsklJEhA/NUyQj+Yvrm6e+mQ9XMrJixJUr9CvyAiRmAPRY+2MR1JYSxsadeZatZAGbF5Jq2ihmMBQebR/4QpFkxJfhCga0t4uV/dkDU+PkQdbUnKqIg/isBlH1gVsw5DWxHuGB+1ac+RFSC2yWS+KBA6hv++mflNfXOGl2jcVFvN9p3HRwJzxpduwEOdWnk2/0CCLA4PhVy8s/CrKtE+vJwTVEseFJGEzieKBrRbgLPU5TVNHgDLb07C4+R3p31Li00P6v8n5CTkZAOGJaY4gmxgLUtMS2jJMjRfEmtiNOHSJ8JXOksRq6jIGOUcAdadaRYnw3XrV4GXcghd1sOwxRIYnTJTArGkLwlxkxdxL4RnigW1d84Qj7EnhN/KESrh0NphvaC1PtgA6S6EADXjh1uLxLlpJAEosaAJFACtqyPffn55It3729Gp8IPEm+VqQ5zwjkYWK6U4u0WYRD4XnG+w0NQKR8TySiSZ6Rg38SuUtBeXJ8YE6laIsBTSKMdFiIx2qg4qKIwMsMKUlnSmmCmutj7rSk/atzkos/LeRt1V/72QrA6kVhBI0VLBtI0cHgfhjP3+K7QyeSWcpkGkVPKh+IJh/4FXBlHSezlxwaZxfN+XM/OUMtBLf66I+aaQQMAaeq6UAeAlUoZRHu/iK+si09GC6TAIfYZdFeD5hpX/srtNxzGnK3IyiVxlJCUIBnaAu5nVow2CF4KNgnR5olZKIhRy5gZb4LwSMbaYjhEjFVinrdq+RLCsQLiI2mRwZWxzLGtKnUTOEjqGP3LQRdHBi9BtMORCrIpoH9Ve9pvb3kO9L2KvD5E5OgHTSE8BnEFMAwIVsqeoNoL1FKOBv9c9Hgz6VGokLLEbMyNITOTpxqsHFwXLydqEcpghp4UJbB2q1cOXXDXCjGnri06FENkbTTkD6RLLm7TM+pMRC6OMq2eHaNtvnr7ngXqEql4fD8oEqVwpdWoEKLEORJ2304M+iMHtDfrEfmEcCQ9UrDS+kdxNKE4gowjn26nPrN+twIanW0eBiCpmhldCT7FGg6y4EMz+FJN+Yo3XOsnIxijWNOQBVxpo9G2wk+71+4bdRI6xEVaHdGIdoqYZzgqWQ9Vuy/YIyBNIBbhKIxB84xCBbFvBAWuIj9AnMRpOCeexZV/KMCOKldRqKZ4qf8CrrThvXgj8DVhjLoRkkIZ2jvwhU23al3DhOCIMIEJKZUAW2Oc3yMXKGLIUnH/alPA2oH/hihFHd2c3+7jMMwSxKz4M25efalNWoXu+czHam+ABKHwkdsOM9R8U/TvscVV6YgcByluxlClSidWmbu81d461JEiFCNlXHAlidFuIHX+aTS73cg8+qQ+v/E+DYq1ZIWYC+s/bIbDXYL1MwtGC6qWP5RIKXAMVZzuzZVzrZymgrejEXUocIXD8gKuEMlWQRLa24lCGgo10rth9s10SuIwSAr+hi5zcaNOAqoIMzqEEy/eiMn4V6ve+TcS6/EFC8F7+Zb1bmehAolVSUjQCiEFdgTP6WGbLpnVSaAIRdr2p0tmToJXCBWKWOTUFI0B6dm+FKw4mUv5QpCmUCD12mcT8wTzh1JiLfqRC/1BjFmqCLSxx3y6ZHZJkfL5JXMf0dIm9RgmzER6hzgxPYF7sf/MTdM/uHR5qawZt0aDmveACBigNdKnaPaZ40AYvssHrXKKRiBDwSlWQSdFyxznUvxKmse5rk7mN8quyiTl3i3HKjBQ7rVjPytIs9z6CfuqdDLCXYIV0bNxMgHdRsfP6qEY1c0lDX2saBtosPEm0rt1Y2tOMVMKvfUlVg6XopWvLlGMDpBefCEcLZKbTvsuWWnm8ptcPenBo2CRMpKUC4f2FHMj21SvOg1clR4aBIzGXwBx3JIpqi17H59qQ6tY5d7C1if7xMPb6VKD2Us98rXh9MNxp1hZ2XaTjJhuzLgQU54AZrQ7T/22c31fSAfY0gDYP+sa/Sie+Cb7ICGV5F9ivlgLOXd+E97lfjnSlOKGJwgJdkdagrnRR0by3R7gzeSOSQBYnhBj2Q0JxB/ojXzS5qtHcjlS7nmxxgDEXK9Pk2siVQcWcGVcn9u2OceM4f6yQBrRNz7vLGxAHkhqAdK0fiApB/UDmXh+ghh6e4p0fMMUxz74Kc9a8txdN40u1p6md9fNQqx0vxdVln656bnvDlsq2yUnn/aPtpwCbaEvXZPcA+IiFSiWGPWAtD4+dIuVVBZjqVdbNHpNKAXdDN9F+P2f/CPQF2DIDS4asZxrPjl1bX0RY4G61qYB07W2QvxMwdqW+fXP/wOiX60z+ngAAA==" />