Merge · Schema

Location

# The Location Object ### Description The `Location` object is used to represent an address that can be associated with an employee. ### Usage Example Fetch from the `LIST Locations` endpoint and filter by `ID` to show all office locations.

IntegrationsPlatformUnified APIAgent HandlerLLM Gateway

Properties

Name	Type	Description
id	string
remote_id	stringnull	The third-party API ID of the matching object.
created_at	string	The datetime that this object was created by Merge.
modified_at	string	The datetime that this object was modified by Merge.
name	stringnull	The location's name.
phone_number	stringnull	The location's phone number.
street_1	stringnull	Line 1 of the location's street address.
street_2	stringnull	Line 2 of the location's street address.
city	stringnull	The location's city.
state	stringnull	The location's state. Represents a region if outside of the US.
zip_code	stringnull	The location's zip code or postal code.
country	object	The location's country. The country code in ISO 3166-1 alpha-2 format.
location_type	object	The location's type. Can be either WORK or HOME
remote_was_deleted	boolean	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 cove
field_mappings	object
remote_data	arraynull

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Location",
  "title": "Location",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "remote_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "The third-party API ID of the matching object."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "The datetime that this object was created by Merge."
    },
    "modified_at": {
      "type": "string",
      "format": "date-time",
      "description": "The datetime that this object was modified by Merge."
    },
    "name": {
      "type": [
        "string",
        "null"
      ],
      "description": "The location's name."
    },
    "phone_number": {
      "type": [
        "string",
        "null"
      ],
      "description": "The location's phone number."
    },
    "street_1": {
      "type": [
        "string",
        "null"
      ],
      "description": "Line 1 of the location's street address."
    },
    "street_2": {
      "type": [
        "string",
        "null"
      ],
      "description": "Line 2 of the location's street address."
    },
    "city": {
      "type": [
        "string",
        "null"
      ],
      "description": "The location's city."
    },
    "state": {
      "type": [
        "string",
        "null"
      ],
      "description": "The location's state. Represents a region if outside of the US."
    },
    "zip_code": {
      "type": [
        "string",
        "null"
      ],
      "description": "The location's zip code or postal code."
    },
    "country": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/CountryEnum"
        },
        {
          "type": "null"
        }
      ],
      "description": "The location's country. The country code in ISO 3166-1 alpha-2 format."
    },
    "location_type": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/LocationTypeEnum"
        },
        {
          "type": "null"
        }
      ],
      "description": "The location's type. Can be either WORK or HOME"
    },
    "remote_was_deleted": {
      "type": "boolean",
      "description": "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_mappings": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/LocationFieldMappings"
        },
        {
          "type": "null"
        }
      ]
    },
    "remote_data": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "#/components/schemas/RemoteData"
      }
    }
  },
  "description": "# The Location Object\n### Description\nThe `Location` object is used to represent an address that can be associated with an employee.\n\n### Usage Example\nFetch from the `LIST Locations` endpoint and filter by `ID` to show all office locations."
}