List Groups
/unified/hris/groups
Query Parameters
Refer Specifying query parameters in Truto APIs
3 supported3 notes
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.
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).
The company (companies.id). Optional: when omitted the company of the connected API token is looked up via /v1/identity/current.
4 supported1 required4 notes
The company ID you want to get the groups for
Flat alternative to company.id.
Flat alternative to company.id.
Flat alternative to company.id.
Filter by the 7shifts location the record belongs to, referencing locations.id.
1 supported
Flat alternative to location.id.
1 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.
1 supported
Type of the group. Some underlying providers use this to differentiate between in-built and user created groups.
business_unitclassclient_teamcost_centerdepartmentdivisiongroupofficeorg_locationorg_unitorganizationpay_groupproject_teamteam+ 2 more
13 supported9 required4 notes
departmentofficeteamcost_centerdepartmentdivisiondepartmentteamorganizationcost_centerdepartmentteamdepartmentclassdepartmentteamdepartmentdivisionteam
Ripplingdepartmentteamgroupdepartmentgroup (default) lists Deel Groups, department lists departments.
org_unitcost_centerorg_unit: HR WORKS organization units (HR WORKS lists active units only). cost_center: cost centers. When omitted (or when both values are given) both are returned: all organization units on the first page (one extra call), then the cost centers page by page. That default needs read permission for BOTH /organization-units and /cost-objects/cost-centers — HR WORKS grants permissions per endpoint, so a key pair that may read only one of them gets 403 for the whole list; pass type in that case. Any other value returns an empty list without calling HR WORKS. Cost objectives are not listed. Several values are supported: repeat the parameter, separate them with commas, use the [] form, or the operator forms [eq] / [in]. Any other form (for example [ne] or a nested object) is refused with a 400 instead of being ignored, so a filter Truto cannot express never returns unfiltered data.
departmentteamOnly departments (Omni /organization/department/) or only teams (/organization/team/). Without it, or with both, departments and teams are returned. Several values: comma-separated, repeated, [] or [in]; [eq] is one value. A value that is neither returns an empty list without calling Omni (Omni HR has only these two group tables); any other operator is refused with a 400.
departmentgroupcost_centerRestrict the list to these group types. department lists Sesame departments; group and cost_center both live in Sesame's entity groups, which Sesame cannot filter on the cost-centre flag, so Truto lists the entity groups and returns only those of the requested type (a page can therefore come back empty while the list continues). Several types are accepted (for example department,group). When omitted, departments are listed first and then entity groups. A value outside the enum returns an empty list. Accepts a plain value, a comma-separated list, repeated keys and [eq]/[in]; any other operator is refused (400) rather than dropped.
Deel Groups only: include archived (deleted) groups. Defaults to false.
1 supported
Filter by group name (Kallidus title). Exact, whole-value match sent as the OData filter title eq '' (Kallidus has no partial match; case sensitivity is not documented). Combined with the other filters using and. Several values mean any of them: Kallidus has no or, so no title condition is sent and this mapping keeps the matching records itself (comparing case-insensitively) — a page can come back short or empty while next_cursor continues, so keep paging until next_cursor is null. The other filters still narrow the query at Kallidus. Accepted forms: name=, name[]= or a repeated name, name[eq]= and name[in]=a,b, all meaning any of the values. name[ne] and name[nin] are refused: Kallidus documents the OData ne operator for users only. A comma separates values only inside [in]; anywhere else it is part of the value. Any other form (name[gte], name[like], ...) is refused with a 400 instead of being dropped.
4 supported
3 supported3 notes
Filter by group category (group_types.id), sent as the OData filter categoryId eq . Combined with the other filters using and. A value that is not a GUID is sent as a quoted string; Kallidus does not document the result (no match, or a 400 for an invalid OData query). Accepted forms: group_type=, group_type[]= or a repeated group_type, group_type[eq]= and group_type[in]=a,b, all meaning any of the values. group_type[ne] and group_type[nin] are refused: Kallidus documents the OData ne operator for users only. A comma separates values in every form. Any other form (group_type[gte], group_type[like], ...) is refused with a 400 instead of being dropped.
List the labor category entries of this labor category (group_types.id) instead of cost centers. UKG lists the entries of one labor category per call. When omitted, all UKG cost centers are returned (type cost_center). Accepts one value, several comma-separated, a repeated key (x[]=a&x[]=b) or an eq/in filter; a filter form UKG cannot express is refused with 400 rather than ignored.
The Workday organization type (group_types.id) to list, e.g. Cost Center or Pay Group. When omitted, supervisory organizations are returned. The type's name (for groups.type) is read with GET /organizationTypes/{id}, which needs the Set Up: Organization security domain, except when the type is the account-context Company type workday_company_org_type_id.
Flat alternative to group_type.id.
3 supported
Parent Group of this group
2 supported2 notes
Return the child groups of this group (groups.id), sent as the OData filter parentGroupId eq . Each returned group then carries parent_group set to this id; without this filter parent_group is always empty, because Kallidus returns no parent on a group and cannot list parent-child links. A value that is not a GUID is sent as a quoted string; Kallidus does not document the result (no match, or a 400 for an invalid OData query). Accepted forms: parent_group=, parent_group[]= or a repeated parent_group, parent_group[eq]= and parent_group[in]=a,b, all meaning any of the values. parent_group[ne] and parent_group[nin] are refused: Kallidus documents the OData ne operator for users only. A comma separates values in every form. Any other form (parent_group[gte], parent_group[like], ...) is refused with a 400 instead of being dropped. One id only: Kallidus has no or, and a group record carries no parent for this mapping to filter on afterwards, so several values are refused with a 400.
Only entity groups whose parent is this group (groups.id of an entity group, Sesame parentId). Implies type=group; Sesame's parentId takes one value, so several are refused (400). Accepts a plain value, a comma-separated list, repeated keys and [eq]/[in]; any other operator is refused (400) rather than dropped.
2 supported2 notes
Flat alternative to parent_group.
Flat alternative to parent_group.id.
Show Truto-specific parameters
The ID of the integrated account to use for the request.
62f44730-dd91-461e-bd6a-aedd9e0ad79dThe format of the response.
unifiedreturns the response with unified mappings applied.rawreturns the unprocessed, raw response from the remote API.normalizedapplies the unified mappings and returns the data in a normalized format.streamreturns 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.debugreturns the final unified result alongside raw remote fetch information. The response is an envelope containingresult(identical to unified mode output) anddebug(withrequestUrl,requestOptions,data,responseHeaders, and for list operations:nextCursor,isLooping,isEmptyResult,resultCount). When the upstream body exceeds 1 MiB,datais replaced by{ truto_truncated: true, truto_max_bytes, truto_excerpt }.debugisnullfor static responses or whentruto_skip_api_call=true.
Defaults to unified.
unifiedunifiedrawnormalizedstreamdebug
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.
idIgnores the limit query parameter.
Excludes the remote_data attribute from the response.
Array of fields to exclude from the response.
truto_exclude_fields[]=id&truto_exclude_fields[]=nameQuery parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.
remote_query[foo]=barResponse Body
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.
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.
List of Groups
The unique identifier for groups
42 supported
Google WorkspaceRipplingThis represents the date when the groups was created
11 supported
RipplingShort description of the group
16 supported
Google WorkspaceGroup's name
42 supported
Google WorkspaceRipplingParent Group of this group
17 supported
RipplingRaw data returned from the remote API call.
Type of the group. Some underlying providers use this to differentiate between in-built and user created groups.
teamdepartmentgroupcost_centerorg_unitofficedivisionbusiness_unitorganizationorg_locationpay_groupproject_teamclient_teamteamclass+ 3 more
35 supported
RipplingThis represents the date when the groups was updated
12 supported
Ripplingtruto unified hris groups \
-a '<integrated_account_id>' \
-o jsonimport Truto from '@truto/truto-ts-sdk';
const truto = new Truto({
token: '<your_api_token>',
});
const result = await truto.unifiedApi.list(
'hris',
'groups',
{ 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",
"groups",
{"integrated_account_id": "<integrated_account_id>"}
):
print(item)
asyncio.run(main())curl -X GET 'https://api.truto.one/unified/hris/groups?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?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"
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())