Skip to content

List Locations

Endpoint

http
GET /unified/hris/locations
Integrations supported
  • Charlie
  • Factorial
  • HeavenHR
  • HR Cloud
  • IntelliHR
  • Kenjo
  • Okta
  • Repute
  • Square

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 will return the response with unified mappings applied.
  • raw will return the raw response from the remote API.
  • normalized will apply the unified mappings and return the data in a normalized format.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
Example: unified
truto_key_by
string

By default the result attribute is an array of objects. This parameter allows you to specify a field in each result objects to use as key, which transforms the result array into an object with the array items keyed by the field. This is useful for when you want to use the result as a lookup table.

Example: id
truto_ignore_limit
boolean

Ignores the limit query parameter.

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
name
string

This represents the name of the location

Supported in
  • Kenjo
postal_code
string

This represents the zip

Supported in
  • Kenjo
country
string

This represents the country

Supported in
  • Kenjo
employee_id
Supported in
  • Okta

Response Body

result
object[]

List of Locations

id
string
REQUIRED · 

The unique identifier for locations

Supported in
  • Charlie
  • Factorial
  • HeavenHR
  • HR Cloud
  • IntelliHR
  • Kenjo
  • Okta
  • Repute
  • Square
name
string

This represents the name of the location

Supported in
  • Charlie
  • Factorial
  • HeavenHR
  • HR Cloud
  • IntelliHR
  • Kenjo
  • Okta
  • Repute
  • Square
phone_number
object

This represents the phone number of the location

Supported in
  • Charlie
  • Factorial
  • Okta
  • 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
  • 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
  • HeavenHR
  • Kenjo
  • Square
state
string

This represents the state

Supported in
  • Factorial
  • Square
postal_code
string

This represents the zip

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

This represents the country

Supported in
  • Charlie
  • Factorial
  • HeavenHR
  • Kenjo
  • Square
location_type
string

This represents the location type

Supported in
  • Kenjo
  • Okta
created_at
string · date-time

This represents the date when the locations was created

Supported in
  • Okta
  • Square
updated_at
string · date-time

This represents the date when the locations was updated

Supported in
  • Okta
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.