Skip to content
GET /unified/hris/companies

Partial response — use the "get" endpoint for the full object.

Query Parameters

Refer Specifying query parameters in Truto APIs

updated_atstring · date-time

This represents the date when the companies was updated

2 supported2 notes
7shifts
supported

Return records modified on or after this date. Accepts an ISO date-time string, or an object with gte or gt. The bound is inclusive: gt is treated as gte. 7shifts filters by date only, so the value is converted to its UTC date and the time part is then ignored.

Humaans
supported

Filter by this timestamp. Accepts either a plain ISO date-time string (implies >=), or an object with gt/gte/lt/lte keys for a range.

include_archivedboolean

Include archived legal entities. Defaults to false (Deel's own default is true).

1 supported
Deel
supported
created_atstring · date-time

Filter by this timestamp. Accepts either a plain ISO date-time string (implies >=), or an object with gt/gte/lt/lte keys for a range.

1 supported
Humaans
supported
display_namestring

This represents the display name

1 supported
Kenjo
supported
organization_type_idstring

Optional. The Workday organization type WID to treat as Company (group_types.id). When omitted, the integrated account's context value workday_company_org_type_id is used; when that is not set either, the organization type whose name is "Company" is looked up with GET /organizationTypes (needs the Set Up: Organization security domain).

1 supported
Workday
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_key_bystring

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_limitboolean

Ignores the limit query parameter.

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

debugobject

Present only when truto_response_format=debug. Contains raw fetch details: requestUrl, requestOptions, data, responseHeaders, nextCursor, isLooping, isEmptyResult, resultCount. data is the parsed upstream body; when its JSON form exceeds 1 MiB it is replaced by { truto_truncated: true, truto_max_bytes, truto_excerpt }, where truto_excerpt is the leading bytes of that body. The same applies to a string requestOptions.body. null for static responses or when truto_skip_api_call=true.

data
isEmptyResultboolean
isLoopingboolean
nextCursorstring
requestOptionsRecord<string, any>
requestUrlstring
responseHeadersRecord<string, any>
resultCountnumber
next_cursorstring

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.

resultobject[]

List of Companies

idstring
required·

The unique identifier for companies

26 supported
7shifts
supported
AlexisHR
supported
Breathe
supported
Charlie
supported
Deel
supported
Google Workspace
supported
Gusto
supported
HeavenHR
supported
Humaans
supported
IntelliHR
supported
JumpCloud
supported
Justworks
supported
Kenjo
supported
Lucca
supported
Oracle Netsuite
supported
Officient
supported
Okta
supported
Omni HR
supported
Paychex
supported
PayFit
supported
Paylocity
supported
Remote
supported
Rippling
supported
Sesame
supported
Square
supported
Workday
supported
created_atstring · date-time

This represents the date when the companies was created

13 supported
7shifts
supported
AlexisHR
supported
Deel
supported
Google Workspace
supported
Humaans
supported
JumpCloud
supported
Justworks
supported
Lucca
supported
Okta
supported
Remote
supported
Rippling
supported
Sesame
supported
Square
supported
display_namestring

This represents the display name

27 supported
7shifts
supported
AlexisHR
supported
Breathe
supported
Charlie
supported
Deel
supported
Google Workspace
supported
Gusto
supported
HeavenHR
supported
HR Partner
supported
Humaans
supported
IntelliHR
supported
JumpCloud
supported
Justworks
supported
Kenjo
supported
Namely
supported
Oracle Netsuite
supported
Officient
supported
Okta
supported
Omni HR
supported
Paychex
supported
PayFit
supported
Paylocity
supported
Remote
supported
Rippling
supported
Sesame
supported
Square
supported
Workday
supported
enisstring[]

This represents the company's Employer Identification Numbers.

4 supported
Justworks
supported
Paychex
supported
PayFit
supported
Paylocity
supported
legal_namestring

This represents the legal name

19 supported
7shifts
supported
Deel
supported
Google Workspace
supported
Gusto
supported
HeavenHR
supported
Humaans
supported
IntelliHR
supported
JumpCloud
supported
Justworks
supported
Lucca
supported
Namely
supported
Oracle Netsuite
supported
Omni HR
supported
Paychex
supported
PayFit
supported
Paylocity
supported
Remote
supported
Rippling
supported
Square
supported
remote_dataRecord<string, any>

Raw data returned from the remote API call.

updated_atstring · date-time

This represents the date when the companies was updated

11 supported
7shifts
supported
AlexisHR
supported
Deel
supported
Humaans
supported
Justworks
supported
Lucca
supported
Oracle Netsuite
supported
Okta
supported
Remote
supported
Rippling
supported
Sesame
supported
truto unified hris companies \
  -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.list(
  'hris',
  'companies',
  { 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():
    async for item in truto_api.unified_api.list(
        "hris",
        "companies",
        {"integrated_account_id": "<integrated_account_id>"}
    ):
        print(item)

asyncio.run(main())
curl -X GET 'https://api.truto.one/unified/hris/companies?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/companies?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/companies"
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())