UNunified
hris
location

Retrieve a location

Changed on

Retrieves a single HrisLocation by its id. Obtain id values from the corresponding list endpoint. Use fields to return only the fields you need.

get/hris/{connection_id}/location/{id}

Request

Path parameters

connection_idstring required

ID of the connection

idstring required

ID of the Location

Query parameters

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Response

Successful

idstring
created_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

namestring

The name of the location

descriptionstring
parent_idstring
external_identifierstring
timezonestring
currencystring
language_localestring
is_activeboolean
is_hqboolean

if this location is the headquarters of the company

company_idstring

(reference to HrisCompany)

rawobject

Changes