Appearance

Get Groups ​

Endpoint ​

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

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 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_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:
  • departments
  • teams
Required in
  • Kenjo

Response Body ​

id
string
REQUIRED · 

The unique identifier for groups

Supported in
  • Charlie
  • Factorial
  • Google Workspace
  • HR Cloud
  • IntelliHR
  • Kenjo
  • Okta
parent_group
string

Parent Group of this group

Supported in
  • IntelliHR
name
string

Group's name

Supported in
  • Charlie
  • Factorial
  • Google Workspace
  • HR Cloud
  • IntelliHR
  • Kenjo
  • Okta
description
string

Short description of the group

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

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

Supported in
  • Charlie
  • Factorial
  • IntelliHR
  • Kenjo
  • Okta
created_at
string · date-time

This represents the date when the groups was created

Supported in
  • Okta
updated_at
string · date-time

This represents the date when the groups was updated

Supported in
  • Okta
remote_data
object

Raw data returned from the remote API call.