Locations

The Location object is used to represent a Location for a Company or Employee address. This is shared across many models and is referenced whenever a location is stored.

The Location object

Properties


idString
Optional

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

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.

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, or - in cases where there is no clear mapping - the original value passed through.

remote_dataRemoteData[]
Optional

The Location object

{
  "id": 123,
  "remote_id": "93018402",
  "phone_number": "+1111111111",
  "street_1": "2920 Broadway",
  "street_2": "2nd Floor",
  "city": "New York ",
  "state": "NY",
  "zip_code": "10027",
  "country": "USA",
  "remote_data": [
    {
      "path": "/locations",
      "data": [
        "Varies by platform"
      ]
    }
  ]
}

GET

/locations

Returns a list of Location objects.


Query & Path Parameters


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

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

cursorString
Optional
The pagination cursor value.

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

modified_afterString
Optional
If provided, will only return objects modified after this datetime.

modified_beforeString
Optional
If provided, will only return objects modified before this datetime.

page_sizeInteger
Optional
Number of results to return per page.

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

Response

{
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
  "previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
  "results": [
    {
      "id": 123,
      "remote_id": "93018402",
      "phone_number": "+1111111111",
      "street_1": "2920 Broadway",
      "street_2": "2nd Floor",
      "city": "New York ",
      "state": "NY",
      "zip_code": "10027",
      "country": "USA",
      "remote_data": [
        {
          "path": "/locations",
          "data": [
            "Varies by platform"
          ]
        }
      ]
    }
  ]
}
Field support by platform

Sapling

Sapling

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


street_2String

cityString

zip_codeString

remote_dataRemoteData[]

phone_numberString

street_1String

stateString

countryEnum

Zenefits

Zenefits

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


street_2String

cityString

zip_codeString

remote_dataRemoteData[]

remote_idString

phone_numberString

street_1String

stateString

countryEnum

Humaans.io

Humaans.io

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


cityString

zip_codeString

remote_dataRemoteData[]

remote_idString

phone_numberString

street_1String

stateString

countryEnum

Gusto

Gusto

Supported Response Fields


street_2String

cityString

zip_codeString

phone_numberString

street_1String

stateString

countryEnum

TriNet

TriNet

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


street_2String

cityString

zip_codeString

remote_dataRemoteData[]

remote_idString

phone_numberString

street_1String

stateString

countryEnum

Paychex

Paychex

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


street_2String

cityString

zip_codeString

remote_dataRemoteData[]

remote_idString

street_1String

stateString

countryEnum

BambooHR

BambooHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


street_2String

cityString

zip_codeString

remote_dataRemoteData[]

street_1String

stateString

countryEnum

Rippling

Rippling

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


street_2String

cityString

zip_codeString

remote_dataRemoteData[]

remote_idString

street_1String

stateString

countryEnum

Hibob

Hibob

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


street_2String

cityString

zip_codeString

remote_dataRemoteData[]

remote_idString

phone_numberString

street_1String

stateString

countryEnum

UKG Pro

UKG Pro

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


street_2String

cityString

zip_codeString

remote_dataRemoteData[]

countryEnum

phone_numberString

street_1String

stateString

remote_idString

Square Payroll

Square Payroll

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


street_2String

cityString

zip_codeString

remote_dataRemoteData[]

remote_idString

phone_numberString

street_1String

stateString

countryEnum

HR Partner

HR Partner

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


street_2String

cityString

zip_codeString

remote_dataRemoteData[]

remote_idString

street_1String

stateString

countryEnum

UKG Ready

UKG Ready

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


street_2String

cityString

zip_codeString

remote_dataRemoteData[]

phone_numberString

street_1String

stateString

countryEnum

Workday

Workday

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


street_2String

cityString

zip_codeString

remote_dataRemoteData[]

countryEnum

street_1String

stateString

remote_idString

ADP Workforce Now

ADP Workforce Now

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


street_2String

cityString

zip_codeString

remote_dataRemoteData[]

street_1String

stateString

countryEnum

Personio

Personio

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


cityString

remote_dataRemoteData[]

remote_idString

Justworks

Justworks

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


street_2String

cityString

zip_codeString

remote_idString

phone_numberString

street_1String

stateString

countryEnum

HR Cloud

HR Cloud

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


street_2String

cityString

zip_codeString

remote_dataRemoteData[]

countryEnum

phone_numberString

street_1String

stateString

remote_idString

Freshteam

Freshteam

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


cityString

zip_codeString

remote_dataRemoteData[]

remote_idString

street_1String

stateString

countryEnum

Sage HR

Sage HR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


street_2String

cityString

zip_codeString

remote_dataRemoteData[]

phone_numberString

street_1String

countryEnum

Namely

Namely

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


street_2String

cityString

zip_codeString

remote_dataRemoteData[]

phone_numberString

street_1String

stateString

countryEnum

Nmbrs

Nmbrs

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


cityString

zip_codeString

remote_dataRemoteData[]

countryEnum

street_1String

stateString

remote_idString

Ceridian Dayforce

Ceridian Dayforce

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


street_2String

cityString

zip_codeString

remote_dataRemoteData[]

countryEnum

street_1String

stateString

remote_idString

Paylocity

Paylocity

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


street_2String

cityString

zip_codeString

remote_dataRemoteData[]

phone_numberString

street_1String

stateString

countryEnum
GET

/locations/{id}

Returns a Location object with the given id.


Query & Path Parameters


idString
Required

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

Response

{
  "id": 123,
  "remote_id": "93018402",
  "phone_number": "+1111111111",
  "street_1": "2920 Broadway",
  "street_2": "2nd Floor",
  "city": "New York ",
  "state": "NY",
  "zip_code": "10027",
  "country": "USA",
  "remote_data": [
    {
      "path": "/locations",
      "data": [
        "Varies by platform"
      ]
    }
  ]
}
Field support by platform

Sapling

Sapling

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


street_2String

cityString

zip_codeString

remote_dataRemoteData[]

phone_numberString

street_1String

stateString

countryEnum

Zenefits

Zenefits

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


street_2String

cityString

zip_codeString

remote_dataRemoteData[]

remote_idString

phone_numberString

street_1String

stateString

countryEnum

Humaans.io

Humaans.io

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


cityString

zip_codeString

remote_dataRemoteData[]

remote_idString

phone_numberString

street_1String

stateString

countryEnum

Gusto

Gusto

Supported Response Fields


street_2String

cityString

zip_codeString

phone_numberString

street_1String

stateString

countryEnum

TriNet

TriNet

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


street_2String

cityString

zip_codeString

remote_dataRemoteData[]

remote_idString

phone_numberString

street_1String

stateString

countryEnum

Paychex

Paychex

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


street_2String

cityString

zip_codeString

remote_dataRemoteData[]

remote_idString

street_1String

stateString

countryEnum

BambooHR

BambooHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


street_2String

cityString

zip_codeString

remote_dataRemoteData[]

street_1String

stateString

countryEnum

Rippling

Rippling

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


street_2String

cityString

zip_codeString

remote_dataRemoteData[]

remote_idString

street_1String

stateString

countryEnum

Hibob

Hibob

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


street_2String

cityString

zip_codeString

remote_dataRemoteData[]

remote_idString

phone_numberString

street_1String

stateString

countryEnum

UKG Pro

UKG Pro

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


street_2String

cityString

zip_codeString

remote_dataRemoteData[]

countryEnum

phone_numberString

street_1String

stateString

remote_idString

Square Payroll

Square Payroll

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


street_2String

cityString

zip_codeString

remote_dataRemoteData[]

remote_idString

phone_numberString

street_1String

stateString

countryEnum

HR Partner

HR Partner

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


street_2String

cityString

zip_codeString

remote_dataRemoteData[]

remote_idString

street_1String

stateString

countryEnum

UKG Ready

UKG Ready

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


street_2String

cityString

zip_codeString

remote_dataRemoteData[]

phone_numberString

street_1String

stateString

countryEnum

Workday

Workday

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


street_2String

cityString

zip_codeString

remote_dataRemoteData[]

countryEnum

street_1String

stateString

remote_idString

ADP Workforce Now

ADP Workforce Now

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


street_2String

cityString

zip_codeString

remote_dataRemoteData[]

street_1String

stateString

countryEnum

Personio

Personio

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


cityString

remote_dataRemoteData[]

remote_idString

Justworks

Justworks

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


street_2String

cityString

zip_codeString

remote_idString

phone_numberString

street_1String

stateString

countryEnum

HR Cloud

HR Cloud

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


street_2String

cityString

zip_codeString

remote_dataRemoteData[]

countryEnum

phone_numberString

street_1String

stateString

remote_idString

Freshteam

Freshteam

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


cityString

zip_codeString

remote_dataRemoteData[]

remote_idString

street_1String

stateString

countryEnum

Sage HR

Sage HR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


street_2String

cityString

zip_codeString

remote_dataRemoteData[]

phone_numberString

street_1String

countryEnum

Namely

Namely

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


street_2String

cityString

zip_codeString

remote_dataRemoteData[]

phone_numberString

street_1String

stateString

countryEnum

Nmbrs

Nmbrs

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


cityString

zip_codeString

remote_dataRemoteData[]

countryEnum

street_1String

stateString

remote_idString

Ceridian Dayforce

Ceridian Dayforce

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


street_2String

cityString

zip_codeString

remote_dataRemoteData[]

countryEnum

street_1String

stateString

remote_idString

Paylocity

Paylocity

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


street_2String

cityString

zip_codeString

remote_dataRemoteData[]

phone_numberString

street_1String

stateString

countryEnum