/locations

import { MergeClient } from "@mergeapi/merge-node-client";
const client = new MergeClient({ apiKey: "YOUR_API_KEY", accountToken: "YOUR_ACCOUNT_TOKEN" });
const pageableResponse = await client.hris.locations.list({
    createdAfter: new Date("2024-01-15T09:30:00.000Z"),
    createdBefore: new Date("2024-01-15T09:30:00.000Z"),
    cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
    includeDeletedData: true,
    includeRemoteData: true,
    includeShellData: true,
    locationType: "HOME",
    modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
    modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
    pageSize: 1,
    remoteFields: "country",
    remoteId: "remote_id",
    showEnumOrigins: "country"
});
for await (const item of pageableResponse) {
    console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.hris.locations.list({
    createdAfter: new Date("2024-01-15T09:30:00.000Z"),
    createdBefore: new Date("2024-01-15T09:30:00.000Z"),
    cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
    includeDeletedData: true,
    includeRemoteData: true,
    includeShellData: true,
    locationType: "HOME",
    modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
    modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
    pageSize: 1,
    remoteFields: "country",
    remoteId: "remote_id",
    showEnumOrigins: "country"
});
while (page.hasNextPage()) {
    page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;

{
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
  "previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
  "results": [
    {
      "id": "f5e6a151-f44e-449a-afb1-8fd781905958",
      "remote_id": "93018402",
      "created_at": "2021-09-15T00:00:00Z",
      "modified_at": "2021-10-16T00:00:00Z",
      "name": "NYC Office",
      "phone_number": "+1111111111",
      "street_1": "2920 Broadway",
      "street_2": "2nd Floor",
      "city": "New York ",
      "state": "NY",
      "zip_code": "10027",
      "country": "US",
      "location_type": "WORK",
      "remote_was_deleted": true,
      "field_mappings": {
        "organization_defined_targets": {
          "custom_key": "custom_value"
        },
        "linked_account_defined_targets": {
          "custom_key": "custom_value"
        }
      },
      "remote_data": [
        {
          "path": "/locations"
        }
      ]
    }
  ]
}

Returns a list of Location objects.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Query parameters

created_afterdatetimeOptional

If provided, will only return objects created after this datetime.

created_beforedatetimeOptional

If provided, will only return objects created before this datetime.

cursorstringOptional

The pagination cursor value.

include_deleted_databooleanOptional

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.

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

location_typeenumOptional

If provided, will only return locations with this location type

HOME - HOME
WORK - WORK

If provided, will only return locations with this location type * `HOME` - HOME * `WORK` - WORK

Allowed values:

modified_afterdatetimeOptional

If provided, only objects synced by Merge after this date time will be returned.

modified_beforedatetimeOptional

If provided, only objects synced by Merge before this date time will be returned.

page_sizeintegerOptional

Number of results to return per page. The maximum limit is 100.

remote_fieldsenumOptional

Deprecated. Use show_enum_origins.

Allowed values:

remote_idstringOptional

The API provider's ID for the given object.

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

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

nextstring or null

previousstring or null

resultslist of objects

Authentication

Headers

Query parameters

Response

Field support by integration