Skip to content

List Locations

Endpoint

http
GET /unified/hris/locations
Integrations supported
  • HR Cloud
  • Okta
  • Repute

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
employee_id
string
The employee ID you want to get the locations for
Required in
  • Okta

Response Body

result
object[]
List of Locations
id
string
REQUIRED · The unique identifier for locations
Supported in
  • HR Cloud
  • Repute
name
string
This represents the name of the location
Supported in
  • HR Cloud
  • Repute
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.
Supported in
  • Okta
street_2
string
This represents the Line 2 of the location's street address.
city
string
This represents the city
Supported in
  • Okta
state
string
This represents the state
Supported in
  • Okta
postal_code
string
This represents the zip
Supported in
  • Okta
country
string
This represents the country
Supported in
  • Okta
location_type
string
This represents the location type
Supported in
  • Okta
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.
next_cursor
string
The cursor to use for the next page of results. Pass this value as `next_cursor` in the query parameter in the next request to get the next page of results.