Skip to content
GET /unified/hris/groups/{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
typestring

Type of the group. Some underlying providers use this to differentiate between in-built and user created groups.

Possible values:
business_unitclassclient_teamcost_centerdepartmentdepartmentsdivisiongroupofficeorg_locationorg_unitorganization+ 4 more
3 supported3 required
Kenjo
required
departmentsteams
Oracle Netsuite
required
departmentclass
Rippling
required
departmentteam
group_typeobject

Required for groups that are not supervisory organizations: the Workday organization type (group_types.id) of the group. When omitted the id is read as a supervisory organization. The type's name (for groups.type) is read with GET /organizationTypes/{id} (Set Up: Organization security domain), except when the type is the account-context Company type workday_company_org_type_id.

1 supported
Workday
supported
idstring
required
group_type_idstring

Flat alternative to group_type.id.

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_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 groups

20 supported
7shifts
supported
Charlie
supported
Factorial
supported
Google
supported
Google Workspace
supported
HR Cloud
supported
HR WORKS
supported
Humaans
supported
IntelliHR
supported
Justworks
supported
Kallidus
supported
Kenjo
supported
Lucca
supported
Oracle Netsuite
supported
Okta
supported
Paychex
supported
Rippling
supported
Sesame
supported
UKG Dimensions
supported
Workday
supported
created_atstring · date-time

This represents the date when the groups was created

5 supported
7shifts
supported
Humaans
supported
Kallidus
supported
Okta
supported
Rippling
supported
descriptionstring

Short description of the group

9 supported
Factorial
supported
Google
supported
Google Workspace
supported
IntelliHR
supported
Kallidus
supported
Lucca
supported
Okta
supported
Sesame
supported
UKG Dimensions
supported
namestring

Group's name

20 supported
7shifts
supported
Charlie
supported
Factorial
supported
Google
supported
Google Workspace
supported
HR Cloud
supported
HR WORKS
supported
Humaans
supported
IntelliHR
supported
Justworks
supported
Kallidus
supported
Kenjo
supported
Lucca
supported
Oracle Netsuite
supported
Okta
supported
Paychex
supported
Rippling
supported
Sesame
supported
UKG Dimensions
supported
Workday
supported
parent_groupstring

Parent Group of this group

9 supported
HR WORKS
supported
Humaans
supported
IntelliHR
supported
Lucca
supported
Oracle Netsuite
supported
Paychex
supported
Rippling
supported
Sesame
supported
Workday
supported
remote_dataRecord<string, any>

Raw data returned from the remote API call.

typestring

Type of the group. Some underlying providers use this to differentiate between in-built and user created groups.

Possible values:
teamdepartmentgroupcost_centerorg_unitofficedivisionbusiness_unitorganizationorg_locationpay_groupproject_team+ 3 more
16 supported
7shifts
supported
Charlie
supported
Factorial
supported
HR WORKS
supported
Humaans
supported
IntelliHR
supported
Justworks
supported
Kenjo
supported
Lucca
supported
Oracle Netsuite
supported
Okta
supported
Paychex
supported
Rippling
supported
Sesame
supported
UKG Dimensions
supported
Workday
supported
updated_atstring · date-time

This represents the date when the groups was updated

6 supported
7shifts
supported
Humaans
supported
Kallidus
supported
Oracle Netsuite
supported
Okta
supported
Rippling
supported
truto unified hris groups '<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',
  'groups',
  '<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",
        "groups",
        "<resource_id>",
        {"integrated_account_id": "<integrated_account_id>"}
    )
    print(result)

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