Skip to content
GET /unified/hris/locations/{id}

Path Parameters

idstring
required·

The ID of the resource.

Example: 23423523

Query Parameters

Refer Specifying query parameters in Truto APIs

companyobject
2 supported2 notes
7shifts
supported

The company to use, referencing companies.id. Optional: when omitted the account's company is looked up automatically. The request fails if the account can see more than one company and none is given.

Paychex
supported

The Paychex company to use, referencing companies.id (Paychex companyId). A company pinned on the connection (company_id in the integrated account context) always wins and this parameter is then ignored. Otherwise, when omitted, the credential's companies are looked up and the single company with API permission is used. The request fails with a 400 when no company can be resolved (the credential sees more than one company with API permission, none, or 100 or more companies).

idstring
required
company_idstring

Flat alternative to company.id.

2 supported
7shifts
supported
Paychex
supported
effective_datestring

Return the record as it is effective on this date (YYYY-MM-DD; a date-time's time part is ignored). Defaults to today's UTC date. UKG business-structure records are effective-dated and UKG requires a date. Accepts a date or date-time string (only the date part is used) or an eq filter; a value that is not a date is refused with 400 rather than ignored.

1 supported
UKG Dimensions
supported
Show Truto-specific parameters
integrated_account_idstring · uuid
required·

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_formatstring

The format of the response.

  • unified returns the response with unified mappings applied.
  • raw returns the unprocessed, raw response from the remote API.
  • normalized applies the unified mappings and returns the data in a normalized format.
  • stream returns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory.
  • debug returns the final unified result alongside raw remote fetch information. The response is an envelope containing result (identical to unified mode output) and debug (with requestUrl, requestOptions, data, responseHeaders, and for list operations: nextCursor, isLooping, isEmptyResult, resultCount). When the upstream body exceeds 1 MiB, data is replaced by { truto_truncated: true, truto_max_bytes, truto_excerpt }. debug is null for static responses or when truto_skip_api_call=true.

Defaults to unified.

Example: unified
Possible values:
unifiedrawnormalizedstreamdebug
truto_ignore_remote_databoolean

Excludes the remote_data attribute from the response.

truto_exclude_fieldsstring[]

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_queryRecord<string, any>

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar

Response Body

idstring
required·

The unique identifier for locations

17 supported
7shifts
supported
Charlie
supported
Factorial
supported
HR Cloud
supported
HR WORKS
supported
Humaans
supported
IntelliHR
supported
Justworks
supported
Kenjo
supported
Oracle Netsuite
supported
Omni HR
supported
Paychex
supported
Rippling
supported
ServiceNow
supported
Sesame
supported
Square
supported
UKG Dimensions
supported
citystring

This represents the city

11 supported
7shifts
supported
Charlie
supported
Factorial
supported
HR WORKS
supported
Humaans
supported
Justworks
supported
Kenjo
supported
Paychex
supported
Rippling
supported
ServiceNow
supported
Square
supported
countrystring

This represents the country

12 supported
7shifts
supported
Charlie
supported
Factorial
supported
HR WORKS
supported
Humaans
supported
Justworks
supported
Kenjo
supported
Omni HR
supported
Paychex
supported
Rippling
supported
ServiceNow
supported
Square
supported
created_atstring · date-time

This represents the date when the locations was created

5 supported
7shifts
supported
Humaans
supported
Rippling
supported
ServiceNow
supported
Square
supported
location_typestring

This represents the location type

6 supported
Justworks
supported
Kenjo
supported
Oracle Netsuite
supported
Rippling
supported
Sesame
supported
UKG Dimensions
supported
namestring

This represents the name of the location

17 supported
7shifts
supported
Charlie
supported
Factorial
supported
HR Cloud
supported
HR WORKS
supported
Humaans
supported
IntelliHR
supported
Justworks
supported
Kenjo
supported
Oracle Netsuite
supported
Omni HR
supported
Paychex
supported
Rippling
supported
ServiceNow
supported
Sesame
supported
Square
supported
UKG Dimensions
supported
phone_numberobject

This represents the phone number of the location

5 supported
Charlie
supported
Factorial
supported
HR WORKS
supported
ServiceNow
supported
Square
supported
extensionstring

This represents the extension of the phone number of the location

numberstring

This represents the phone number of the location

postal_codestring

This represents the zip

10 supported
Charlie
supported
Factorial
supported
HR WORKS
supported
Humaans
supported
Justworks
supported
Kenjo
supported
Paychex
supported
Rippling
supported
ServiceNow
supported
Square
supported
remote_dataRecord<string, any>

Raw data returned from the remote API call.

statestring

This represents the state

9 supported
7shifts
supported
Factorial
supported
HR WORKS
supported
Humaans
supported
Justworks
supported
Paychex
supported
Rippling
supported
ServiceNow
supported
Square
supported
street_1string

This represents the Line 1 of the location's street address.

14 supported
7shifts
supported
Charlie
supported
Factorial
supported
HR WORKS
supported
Humaans
supported
Justworks
supported
Kenjo
supported
Omni HR
supported
Paychex
supported
Rippling
supported
ServiceNow
supported
Sesame
supported
Square
supported
UKG Dimensions
supported
street_2string

This represents the Line 2 of the location's street address.

6 supported
Charlie
supported
Factorial
supported
HR WORKS
supported
Justworks
supported
Paychex
supported
Square
supported
updated_atstring · date-time

This represents the date when the locations was updated

5 supported
7shifts
supported
Humaans
supported
Oracle Netsuite
supported
Rippling
supported
ServiceNow
supported
truto unified hris locations '<resource_id>' \
  -m get \
  -a '<integrated_account_id>' \
  -o json
import Truto from '@truto/truto-ts-sdk';

const truto = new Truto({
  token: '<your_api_token>',
});

const result = await truto.unifiedApi.get(
  'hris',
  'locations',
  '<resource_id>',
  { integrated_account_id: '<integrated_account_id>' }
);

console.log(result);
import asyncio
from truto_python_sdk import TrutoApi

truto_api = TrutoApi(token="<your_api_token>")

async def main():
    result = await truto_api.unified_api.get(
        "hris",
        "locations",
        "<resource_id>",
        {"integrated_account_id": "<integrated_account_id>"}
    )
    print(result)

asyncio.run(main())
curl -X GET 'https://api.truto.one/unified/hris/locations/{id}?integrated_account_id=<integrated_account_id>' \
  -H 'Authorization: Bearer <your_api_token>' \
  -H 'Content-Type: application/json'
const integratedAccountId = '<integrated_account_id>';

const response = await fetch(`https://api.truto.one/unified/hris/locations/{id}?integrated_account_id=${integratedAccountId}`, {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer <your_api_token>',
    'Content-Type': 'application/json',
  },
});

const data = await response.json();
console.log(data);
import requests

url = "https://api.truto.one/unified/hris/locations/{id}"
headers = {
    "Authorization": "Bearer <your_api_token>",
    "Content-Type": "application/json",
}
params = {
    "integrated_account_id": "<integrated_account_id>"
}

response = requests.get(url, headers=headers, params=params)
print(response.json())