Appearance

Get Locations ​

Endpoint ​

http
GET /unified/hris/locations/{id}
Integrations supported
  • Charlie
  • Factorial
  • HR Cloud
  • IntelliHR
  • Kenjo
  • Oracle Netsuite
  • Rippling
  • ServiceNow
  • Square

Path parameters ​

id
string
REQUIRED · 

The ID of the resource.

Example: 23423523

Query parameters ​

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

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

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

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). debug is null for static responses or when truto_skip_api_call=true.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
  • stream
  • debug
Example: unified
truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

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 ​

id
string
REQUIRED · 

The unique identifier for locations

Supported in
  • Charlie
  • Factorial
  • HR Cloud
  • IntelliHR
  • Kenjo
  • Oracle Netsuite
  • Rippling
  • ServiceNow
  • Square
name
string

This represents the name of the location

Supported in
  • Charlie
  • Factorial
  • HR Cloud
  • IntelliHR
  • Kenjo
  • Oracle Netsuite
  • Rippling
  • ServiceNow
  • Square
phone_number
object

This represents the phone number of the location

Supported in
  • Charlie
  • Factorial
  • ServiceNow
  • Square
number
string

This represents the phone number of the location

extension
string

This represents the extension of the phone number of the location

street_1
string

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

Supported in
  • Charlie
  • Factorial
  • Kenjo
  • Rippling
  • ServiceNow
  • Square
street_2
string

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

Supported in
  • Charlie
  • Factorial
  • Square
city
string

This represents the city

Supported in
  • Charlie
  • Factorial
  • Kenjo
  • Rippling
  • ServiceNow
  • Square
state
string

This represents the state

Supported in
  • Factorial
  • Rippling
  • ServiceNow
  • Square
postal_code
string

This represents the zip

Supported in
  • Charlie
  • Factorial
  • Kenjo
  • Rippling
  • ServiceNow
  • Square
country
string

This represents the country

Supported in
  • Charlie
  • Factorial
  • Kenjo
  • Rippling
  • ServiceNow
  • Square
location_type
string

This represents the location type

Supported in
  • Kenjo
  • Oracle Netsuite
  • Rippling
created_at
string · date-time

This represents the date when the locations was created

Supported in
  • Rippling
  • ServiceNow
  • Square
updated_at
string · date-time

This represents the date when the locations was updated

Supported in
  • Oracle Netsuite
  • Rippling
  • ServiceNow
remote_data
object

Raw data returned from the remote API call.