For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Logo
Resources
Log inGet a demo
Get startedAPI referenceImplementation
Get startedAPI referenceImplementation
    • Overview
          • The Location object
          • GET/locations
          • GET/locations/{id}

Get started

  • Overview
  • Introduction
  • Unified API
  • Linked Account
  • Merge Link
  • Use cases

Implementation

  • Sandboxes
  • SDKs
  • API access
  • Syncing data
  • Writing data
  • Data minimization
  • Supplemental data
  • Errors
  • Integration metadata

API reference

  • ATS
  • HRIS
  • Accounting
  • Ticketing
  • CRM
  • File Storage
  • Knowledge Base
  • Chat

Resources

  • Help Center
  • Merge.dev
  • Changelog
© Merge 2026Terms of usePrivacy policy
UnifiedAgent HandlerGateway
UnifiedAgent HandlerGateway
Resources
Log inGet a demo
Common ModelsLocations

The Location object

The Location Object
1{
2  "id": "string",
3  "remote_id": "string",
4  "created_at": "2023-01-01T00:00:00Z",
5  "modified_at": "2023-01-01T00:00:00Z",
6  "name": "string",
7  "phone_number": "string",
8  "street_1": "string",
9  "street_2": "string",
10  "city": "string",
11  "state": "string",
12  "zip_code": "string",
13  "country": "AF",
14  "location_type": "HOME",
15  "remote_was_deleted": true,
16  "field_mappings": {
17    "organization_defined_targets": {
18      "string": {}
19    },
20    "linked_account_defined_targets": {
21      "string": {}
22    }
23  },
24  "remote_data": [
25    {
26      "path": "string",
27      "data": {}
28    }
29  ]
30}
Was this page helpful?
Previous

/groups/types

Next

/locations

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
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