Appearance

Get Groups ​

Endpoint ​

http
GET /unified/hris/groups/{id}
Integrations supported
  • Charlie
  • Factorial
  • Google
  • Google Workspace
  • HR Cloud
  • IntelliHR
  • Kenjo
  • Lucca
  • Oracle Netsuite
  • Okta
  • Rippling

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

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

All possible enum values:
  • business_unit
  • class
  • client_team
  • cost_center
  • department
  • departments
  • division
  • group
  • office
  • org_location
  • org_unit
  • organization
  • pay_group
  • project_team
  • team
  • teams
Enum support by integration
  • Kenjo
    • departments
    • teams
  • Oracle Netsuite
    • department
    • class
  • Rippling
    • department
    • team
Required in
  • Kenjo
  • Oracle Netsuite
  • Rippling

Response Body ​

id
string
REQUIRED · 

The unique identifier for groups

Supported in
  • Charlie
  • Factorial
  • Google
  • Google Workspace
  • HR Cloud
  • IntelliHR
  • Kenjo
  • Lucca
  • Oracle Netsuite
  • Okta
  • Rippling
parent_group
string

Parent Group of this group

Supported in
  • IntelliHR
  • Lucca
  • Oracle Netsuite
  • Rippling
name
string

Group's name

Supported in
  • Charlie
  • Factorial
  • Google
  • Google Workspace
  • HR Cloud
  • IntelliHR
  • Kenjo
  • Lucca
  • Oracle Netsuite
  • Okta
  • Rippling
description
string

Short description of the group

Supported in
  • Factorial
  • Google
  • Google Workspace
  • IntelliHR
  • Lucca
  • Okta
type
string

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

All possible enum values:
  • team
  • department
  • group
  • cost_center
  • org_unit
  • office
  • division
  • business_unit
  • organization
  • org_location
  • pay_group
  • project_team
  • client_team
  • class
Supported in
  • Charlie
  • Factorial
  • IntelliHR
  • Kenjo
  • Lucca
  • Oracle Netsuite
  • Okta
  • Rippling
created_at
string · date-time

This represents the date when the groups was created

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

This represents the date when the groups was updated

Supported in
  • Oracle Netsuite
  • Okta
  • Rippling
remote_data
object

Raw data returned from the remote API call.