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

idUUID
Required

remote_idString
Optional
The third-party API ID of the matching object.

created_atDateTime (ISO 8601)
Required
The datetime that this object was created by Merge.

modified_atDateTime (ISO 8601)
Required
The datetime that this object was modified by Merge.

nameString
Optional
The location's name.

phone_numberString
Optional
The location's phone number.

street_1String
Optional
Line 1 of the location's street address.

street_2String
Optional
Line 2 of the location's street address.

cityString
Optional
The location's city.

stateString
Optional
The location's state. Represents a region if outside of the US.

zip_codeString
Optional
The location's zip code or postal code.

countryEnum
Optional
The 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.

location_typeEnum
Optional
The 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.

remote_was_deletedBoolean
Required
Indicates whether or not this object has been deleted in the third party platform.

field_mappingsObject
Optional

remote_dataRemoteData[]
Optional


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.

cursorString
Optional
The pagination cursor value.

include_deleted_dataBoolean
Optional
Whether to include data that was marked as deleted by third party webhooks.

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.

location_typeString
Optional
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_sizeInteger
Optional
Number of results to return per page.

remote_fieldsString
Optional
Deprecated. Use show_enum_origins.

remote_idString
Optional
The API provider's ID for the given object.

show_enum_originsString
Optional
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
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
7shifts
7shifts
ADP Workforce Now
ADP Workforce Now
AlexisHR
AlexisHR
AllianceHCM
AllianceHCM
Altera Payroll
Altera Payroll
BambooHR
BambooHR
Breathe
Breathe
Charlie
Charlie
ChartHop
ChartHop
ClayHR
ClayHR
Dayforce
Dayforce
Deel
Deel
Employment Hero
Employment Hero
Factorial
Factorial
Freshteam
Freshteam
Google Workspace
Google Workspace
Gusto
Hailey HR
Hailey HR
Hibob
Hibob
HR Cloud
HR Cloud
HR Partner
HR Partner
Humaans
Humaans
Humi
Humi
Insperity Premier
Insperity Premier
IntelliHR
IntelliHR
IRIS Cascade
IRIS Cascade
JumpCloud
JumpCloud
Justworks
Justworks
Kallidus
Kallidus
Keka
Keka
Kenjo
Kenjo
Lucca
Lucca
Namely
Namely
Nmbrs
Nmbrs
Officient
Officient
Okta
Okta
Oracle Cloud Human Capital Management (HCM)
Oracle Cloud Human Capital Management (HCM)
OysterHR
OysterHR
PayCaptain
PayCaptain
Paychex
Paychex
Paycom
Paycom
Paycor
Paycor
PayFit
PayFit
Paylocity
Paylocity
PeopleHR
PeopleHR
Personio
Personio
PingOne
PingOne
Proliant
Proliant
Remote
Remote
Rippling
Rippling
Sage HR
Sage HR
SAP SuccessFactors
SAP SuccessFactors
Sesame
Sesame
Square Payroll
Square Payroll
TriNet
TriNet
TriNet HR Platform
TriNet HR Platform
UKG Pro
UKG Pro
UKG Pro Workforce Management
UKG Pro Workforce Management
UKG Ready
UKG Ready
Workday
Workday
Zelt
Zelt
Zoho People
Zoho People
GET
/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

idUUID
Required

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.

remote_fieldsString
Optional
Deprecated. Use show_enum_origins.

show_enum_originsString
Optional
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
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
7shifts
7shifts
ADP Workforce Now
ADP Workforce Now
AlexisHR
AlexisHR
AllianceHCM
AllianceHCM
Altera Payroll
Altera Payroll
BambooHR
BambooHR
Breathe
Breathe
Charlie
Charlie
ChartHop
ChartHop
ClayHR
ClayHR
Dayforce
Dayforce
Deel
Deel
Employment Hero
Employment Hero
Factorial
Factorial
Freshteam
Freshteam
Google Workspace
Google Workspace
Gusto
Hailey HR
Hailey HR
Hibob
Hibob
HR Cloud
HR Cloud