Appearance

Get Locations ​

Endpoint ​

http
GET /unified/hris/locations/{id}
Integrations supported
  • HR Cloud

Path parameters ​

id
string
REQUIRED · The ID of the resource.
Example: 23423523

Query parameters ​

integrated_account_id
string · uuid
REQUIRED · The ID of the integrated account to use for the request.
Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d

Response Body ​

id
string
REQUIRED · The unique identifier for locations
Supported in
  • HR Cloud
name
string
This represents the name of the location
Supported in
  • HR Cloud
phone_number
string
This represents the phone number of the location
street_1
string
This represents the Line 1 of the location's street address.
street_2
string
This represents the Line 2 of the location's street address.
city
string
This represents the city
state
string
This represents the state
postal_code
string
This represents the zip
country
string
This represents the country
location_type
string
This represents the location type
created_at
string
This represents the date when the locations was created
updated_at
string
This represents the date when the locations was updated
remote_data
object
Raw data returned from the remote API call.