Locations
The
Location object is used to represent an address that can be associated with an employee.Properties
idUUIDremote_idStringThe third-party API ID of the matching object.
created_atDateTime (ISO 8601)The datetime that this object was created by Merge.
modified_atDateTime (ISO 8601)The datetime that this object was modified by Merge.
nameStringThe location's name.
phone_numberStringThe location's phone number.
street_1StringLine 1 of the location's street address.
street_2StringLine 2 of the location's street address.
cityStringThe location's city.
stateStringThe location's state. Represents a region if outside of the US.
zip_codeStringThe location's zip code or postal code.
countryEnumThe location's country. Possible values include:
AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, CV, KH, CM, CA, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CU, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, KP, MK, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, KR, SS, ES, LK, SD, SR, SJ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, UM, US, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW. In cases where there is no clear mapping, the original value passed through will be returned. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.location_typeEnumThe location's type. Can be either WORK or HOME Possible values include:
HOME, WORK. In cases where there is no clear mapping, the original value passed through will be returned. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.remote_was_deletedBooleanIndicates 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_mappingsObjectremote_dataRemoteData[]The RemoteData object
The
RemoteData object is used to represent the full data pulled from the third-party API for an object.Properties
pathStringThe third-party API path that is being called.
dataAnyThe data returned from the third-party for this object in its original, unnormalized format.
GET
/locations
https://api.merge.dev/api/hris/v1/locations
US
EU
APAC
Returns a list of Location objects.
Query & path parameters
created_afterDateTime (ISO 8601)Optional
If provided, will only return objects created after this datetime.
created_beforeDateTime (ISO 8601)Optional
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_typeStringOptional
If provided, will only return locations with this location_type
modified_afterDateTime (ISO 8601)Optional
If provided, only objects synced by Merge after this date time will be returned.
modified_beforeDateTime (ISO 8601)Optional
If provided, only objects synced by Merge before this date time will be returned.
page_sizeIntegerOptional
Number of results to return per page.
remote_fieldsStringOptional
Deprecated. Use show_enum_origins.
remote_idStringOptional
The API provider's ID for the given object.
show_enum_originsStringOptional
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
Field support by integration
Use the /linked-accounts endpoint to pull platform support information
7shifts
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringphone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idStringstateStringstreet_1Stringzip_codeString
ADP DECIDIUM
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringstateStringstreet_1Stringstreet_2Stringzip_codeString
ADP RUN
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringremote_dataRemoteData[]pathstringdatastringstateStringstreet_1Stringstreet_2Stringzip_codeString
ADP Workforce Now
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringphone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idStringstateStringstreet_1Stringstreet_2Stringzip_codeString
AlexisHR
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringphone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idStringstreet_1Stringzip_codeString
AllianceHCM
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumremote_dataRemoteData[]pathstringdatastringstateStringstreet_1Stringstreet_2Stringzip_codeString
Altera Payroll
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumphone_numberStringstateStringstreet_1Stringstreet_2Stringzip_codeString
BambooHR
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringphone_numberStringremote_dataRemoteData[]pathstringdatastringstateStringstreet_1Stringstreet_2Stringzip_codeString
Breathe
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringphone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idStringstateStringstreet_1Stringstreet_2Stringzip_codeString
Cezanne HR
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumremote_dataRemoteData[]pathstringdatastringstreet_1Stringstreet_2Stringzip_codeString
Charlie
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringphone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idStringstateStringstreet_1Stringstreet_2Stringzip_codeString
ChartHop
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringphone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idStringstreet_1Stringstreet_2Stringzip_codeString
ClayHR
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
nameStringremote_idString
CoolCare
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumphone_numberStringremote_dataRemoteData[]pathstringdatastringstateStringstreet_1Stringstreet_2Stringzip_codeString
Darwinbox
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumremote_idStringstateStringstreet_1Stringzip_codeString
Dayforce
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringstateStringstreet_1Stringstreet_2Stringzip_codeString
Deel
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringstateStringstreet_1Stringzip_codeString
Employment Hero
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
countryEnumnameString
Factorial
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringphone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idStringstateStringstreet_1Stringstreet_2Stringzip_codeString
Freshteam
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringstateStringstreet_1Stringzip_codeString
Google Workspace
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringphone_numberStringstateStringstreet_1Stringzip_codeString
Gusto
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumphone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idStringstateStringstreet_1Stringstreet_2Stringzip_codeString
Hailey HR
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringphone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idStringstreet_1Stringzip_codeString
Hibob
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringphone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idStringstateStringstreet_1Stringstreet_2Stringzip_codeString
HR Cloud
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringphone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idStringstateStringstreet_1Stringstreet_2Stringzip_codeString
HR Partner
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringstateStringstreet_1Stringstreet_2Stringzip_codeString
HRWorks
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringphone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idStringstateStringstreet_1Stringzip_codeString
Humaans
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringphone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idStringstateStringstreet_1Stringzip_codeString
Humi
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumremote_dataRemoteData[]pathstringdatastringstateStringstreet_1Stringzip_codeString
Insperity Premier
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumphone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idStringstateStringstreet_1Stringstreet_2Stringzip_codeString
IntelliHR
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringstateStringstreet_1Stringzip_codeString
IRIS Cascade
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
location_typeEnumremote_dataRemoteData[]pathstringdatastringstreet_1Stringstreet_2Stringzip_codeString
ISolved
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringlocation_typeEnumremote_dataRemoteData[]pathstringdatastringremote_idStringstateStringstreet_1Stringstreet_2Stringzip_codeString
JumpCloud
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumphone_numberStringremote_idStringstateStringstreet_1Stringzip_codeString
Justworks
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringphone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idStringstateStringstreet_1Stringstreet_2Stringzip_codeString
Kallidus
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumphone_numberStringremote_dataRemoteData[]pathstringdatastringstateStringstreet_1Stringstreet_2Stringzip_codeString
Keka
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumremote_dataRemoteData[]pathstringdatastringstateStringstreet_1Stringstreet_2Stringzip_codeString
Kenjo
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringremote_idStringstreet_1Stringzip_codeString
Leapsome
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
location_typeEnumnameString
Lucca
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringremote_dataRemoteData[]pathstringdatastringstreet_1Stringzip_codeString
Microsoft Entra ID
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumstateStringstreet_1Stringzip_codeString
Namely
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringphone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idStringstateStringstreet_1Stringstreet_2Stringzip_codeString
Nmbrs
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumremote_dataRemoteData[]pathstringdatastringremote_idStringstateStringstreet_1Stringzip_codeString
Officient
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumremote_dataRemoteData[]pathstringdatastringstateStringstreet_1Stringstreet_2Stringzip_codeString
Okta
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumstateStringstreet_1Stringzip_codeString
Oracle Cloud Human Capital Management (HCM)
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringstateStringstreet_1Stringstreet_2Stringzip_codeString
OysterHR
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumremote_dataRemoteData[]pathstringdatastringremote_idStringstateStringstreet_1Stringstreet_2Stringzip_codeString
PayCaptain
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumremote_dataRemoteData[]pathstringdatastringstateStringstreet_1Stringzip_codeString
Paychex
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringstateStringstreet_1Stringstreet_2Stringzip_codeString
Paycom
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringstateStringstreet_1Stringzip_codeString
Paycor
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringremote_idStringstateStringstreet_1Stringstreet_2Stringzip_codeString
PayFit
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumremote_dataRemoteData[]pathstringdatastringstreet_1Stringzip_codeString
Paylocity
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringphone_numberStringremote_dataRemoteData[]pathstringdatastringstateStringstreet_1Stringstreet_2Stringzip_codeString
PeopleHR
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringremote_dataRemoteData[]pathstringdatastringstateStringstreet_1Stringstreet_2Stringzip_codeString
Personio
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringlocation_typeEnumnameStringremote_dataRemoteData[]pathstringdatastringremote_idString
PingOne
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumstateStringstreet_1String
Planday
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringphone_numberStringremote_dataRemoteData[]pathstringdatastringstreet_1Stringstreet_2Stringzip_codeString
Proliant
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumphone_numberStringremote_dataRemoteData[]pathstringdatastringstateStringstreet_1Stringstreet_2Stringzip_codeString
Remote
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumremote_dataRemoteData[]pathstringdatastringstateStringstreet_1Stringzip_codeString
Rippling
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringphone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idStringstateStringstreet_1Stringstreet_2Stringzip_codeString
Sage HR
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumphone_numberStringremote_dataRemoteData[]pathstringdatastringstreet_1Stringstreet_2Stringzip_codeString
Sage People
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringremote_dataRemoteData[]pathstringdatastringstateStringstreet_1Stringstreet_2Stringzip_codeString
SAP SuccessFactors
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringphone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idStringstateStringstreet_1Stringstreet_2Stringzip_codeString
Sesame
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
location_typeEnumnameStringphone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idStringstreet_1Stringzip_codeString
Square Payroll
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumnameStringphone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idStringstateStringstreet_1Stringstreet_2Stringzip_codeString
TriNet
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringphone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idStringstateStringstreet_1Stringstreet_2Stringzip_codeString
TriNet HR Platform
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringphone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idStringstateStringstreet_1Stringstreet_2Stringzip_codeString
UKG Pro
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringphone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idStringstateStringstreet_1Stringstreet_2Stringzip_codeString
UKG Pro Workforce Management
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumstateStringstreet_1Stringzip_codeString
UKG Ready
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumphone_numberStringremote_dataRemoteData[]pathstringdatastringstateStringstreet_1Stringstreet_2Stringzip_codeString
Workday
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumphone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idStringstateStringstreet_1Stringstreet_2Stringzip_codeString
Zelt
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringstateStringstreet_1Stringzip_codeString
Zoho People
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumstateStringstreet_1Stringstreet_2Stringzip_codeStringGET
/locations/{id}
https://api.merge.dev/api/hris/v1/locations/{id}
US
EU
APAC
Returns a Location object with the given id.
Query & path parameters
idUUIDRequired
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_fieldsStringOptional
Deprecated. Use show_enum_origins.
show_enum_originsStringOptional
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
Field support by integration
Use the /linked-accounts endpoint to pull platform support information
7shifts
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringphone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idStringstateStringstreet_1Stringzip_codeStringADP DECIDIUM
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringstateStringstreet_1Stringstreet_2Stringzip_codeStringADP RUN
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringremote_dataRemoteData[]pathstringdatastringstateStringstreet_1Stringstreet_2Stringzip_codeStringADP Workforce Now
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringphone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idStringstateStringstreet_1Stringstreet_2Stringzip_codeStringAlexisHR
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringphone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idStringstreet_1Stringzip_codeStringAllianceHCM
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumremote_dataRemoteData[]pathstringdatastringstateStringstreet_1Stringstreet_2Stringzip_codeStringAltera Payroll
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumphone_numberStringstateStringstreet_1Stringstreet_2Stringzip_codeStringBambooHR
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringphone_numberStringremote_dataRemoteData[]pathstringdatastringstateStringstreet_1Stringstreet_2Stringzip_codeStringBreathe
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringphone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idStringstateStringstreet_1Stringstreet_2Stringzip_codeStringCezanne HR
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumremote_dataRemoteData[]pathstringdatastringstreet_1Stringstreet_2Stringzip_codeStringCharlie
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringphone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idStringstateStringstreet_1Stringstreet_2Stringzip_codeStringChartHop
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringphone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idStringstreet_1Stringstreet_2Stringzip_codeStringClayHR
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
nameStringremote_idStringCoolCare
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumphone_numberStringremote_dataRemoteData[]pathstringdatastringstateStringstreet_1Stringstreet_2Stringzip_codeStringDarwinbox
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumremote_idStringstateStringstreet_1Stringzip_codeStringDayforce
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringstateStringstreet_1Stringstreet_2Stringzip_codeStringDeel
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringstateStringstreet_1Stringzip_codeStringEmployment Hero
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
countryEnumnameStringFactorial
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringphone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idStringstateStringstreet_1Stringstreet_2Stringzip_codeStringFreshteam
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringstateStringstreet_1Stringzip_codeStringGoogle Workspace
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringphone_numberStringstateStringstreet_1Stringzip_codeStringGusto
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumphone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idStringstateStringstreet_1Stringstreet_2Stringzip_codeStringHailey HR
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringphone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idStringstreet_1Stringzip_codeStringHibob
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringphone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idStringstateStringstreet_1Stringstreet_2Stringzip_codeStringHR Cloud
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringphone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idStringstateStringstreet_1Stringstreet_2Stringzip_codeStringHR Partner
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringstateStringstreet_1Stringstreet_2Stringzip_codeStringHRWorks
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringphone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idStringstateStringstreet_1Stringzip_codeStringHumaans
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringphone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idStringstateStringstreet_1Stringzip_codeStringHumi
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumremote_dataRemoteData[]pathstringdatastringstateStringstreet_1Stringzip_codeStringInsperity Premier
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumphone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idStringstateStringstreet_1Stringstreet_2Stringzip_codeStringIntelliHR
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringstateStringstreet_1Stringzip_codeStringIRIS Cascade
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
location_typeEnumremote_dataRemoteData[]pathstringdatastringstreet_1Stringstreet_2Stringzip_codeStringISolved
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringlocation_typeEnumremote_dataRemoteData[]pathstringdatastringremote_idStringstateStringstreet_1Stringstreet_2Stringzip_codeStringJumpCloud
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumphone_numberStringremote_idStringstateStringstreet_1Stringzip_codeStringJustworks
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringphone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idStringstateStringstreet_1Stringstreet_2Stringzip_codeStringKallidus
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumphone_numberStringremote_dataRemoteData[]pathstringdatastringstateStringstreet_1Stringstreet_2Stringzip_codeStringKeka
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumremote_dataRemoteData[]pathstringdatastringstateStringstreet_1Stringstreet_2Stringzip_codeStringKenjo
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringremote_idStringstreet_1Stringzip_codeStringLeapsome
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
location_typeEnumnameStringLucca
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringremote_dataRemoteData[]pathstringdatastringstreet_1Stringzip_codeStringMicrosoft Entra ID
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumstateStringstreet_1Stringzip_codeStringNamely
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringphone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idStringstateStringstreet_1Stringstreet_2Stringzip_codeStringNmbrs
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumremote_dataRemoteData[]pathstringdatastringremote_idStringstateStringstreet_1Stringzip_codeStringOfficient
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumremote_dataRemoteData[]pathstringdatastringstateStringstreet_1Stringstreet_2Stringzip_codeStringOkta
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumstateStringstreet_1Stringzip_codeStringOracle Cloud Human Capital Management (HCM)
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringstateStringstreet_1Stringstreet_2Stringzip_codeStringOysterHR
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumremote_dataRemoteData[]pathstringdatastringremote_idStringstateStringstreet_1Stringstreet_2Stringzip_codeStringPayCaptain
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumremote_dataRemoteData[]pathstringdatastringstateStringstreet_1Stringzip_codeStringPaychex
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringstateStringstreet_1Stringstreet_2Stringzip_codeStringPaycom
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringstateStringstreet_1Stringzip_codeStringPaycor
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringremote_idStringstateStringstreet_1Stringstreet_2Stringzip_codeStringPayFit
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumremote_dataRemoteData[]pathstringdatastringstreet_1Stringzip_codeStringPaylocity
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringphone_numberStringremote_dataRemoteData[]pathstringdatastringstateStringstreet_1Stringstreet_2Stringzip_codeStringPeopleHR
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringremote_dataRemoteData[]pathstringdatastringstateStringstreet_1Stringstreet_2Stringzip_codeStringPersonio
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringlocation_typeEnumnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringPingOne
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumstateStringstreet_1StringPlanday
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringphone_numberStringremote_dataRemoteData[]pathstringdatastringstreet_1Stringstreet_2Stringzip_codeStringProliant
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumphone_numberStringremote_dataRemoteData[]pathstringdatastringstateStringstreet_1Stringstreet_2Stringzip_codeStringRemote
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumremote_dataRemoteData[]pathstringdatastringstateStringstreet_1Stringzip_codeStringRippling
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringphone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idStringstateStringstreet_1Stringstreet_2Stringzip_codeStringSage HR
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumphone_numberStringremote_dataRemoteData[]pathstringdatastringstreet_1Stringstreet_2Stringzip_codeStringSage People
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringremote_dataRemoteData[]pathstringdatastringstateStringstreet_1Stringstreet_2Stringzip_codeStringSAP SuccessFactors
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringphone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idStringstateStringstreet_1Stringstreet_2Stringzip_codeStringSesame
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
location_typeEnumnameStringphone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idStringstreet_1Stringzip_codeStringSquare Payroll
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumnameStringphone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idStringstateStringstreet_1Stringstreet_2Stringzip_codeStringTriNet
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringphone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idStringstateStringstreet_1Stringstreet_2Stringzip_codeStringTriNet HR Platform
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringphone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idStringstateStringstreet_1Stringstreet_2Stringzip_codeStringUKG Pro
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringphone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idStringstateStringstreet_1Stringstreet_2Stringzip_codeStringUKG Pro Workforce Management
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumstateStringstreet_1Stringzip_codeStringUKG Ready
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumphone_numberStringremote_dataRemoteData[]pathstringdatastringstateStringstreet_1Stringstreet_2Stringzip_codeStringWorkday
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumphone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idStringstateStringstreet_1Stringstreet_2Stringzip_codeStringZelt
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumlocation_typeEnumnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringstateStringstreet_1Stringzip_codeStringZoho People
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cityStringcountryEnumstateStringstreet_1Stringstreet_2Stringzip_codeString