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}
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  "remote_data": [
18    {
19      "path": "string",
20      "data": {}
21    }
22  ]
23}
Was this page helpful?
Previous

/groups/types

Next

/locations

Built with

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

idstringOptionalRead-onlyformat: "uuid"
remote_idstring or nullOptional
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
location_typeenum or nullOptional
Allowed values:
remote_was_deletedbooleanOptionalRead-only
field_mappingsobject or nullOptionalRead-only
remote_datalist of objects or nullOptionalRead-only