Appearance

List Groups ​

Endpoint ​

http
GET /unified/hris/groups
Integrations supported
  • AlexisHR
  • Breathe
  • Charlie
  • ClayHR
  • Factorial
  • Google Workspace
  • greytHR
  • Gusto
  • Hailey HR
  • HeavenHR
  • HiBob
  • HR Cloud
  • HR Partner
  • IntelliHR
  • JumpCloud
  • Keka
  • Kenjo
  • Namely
  • Officient
  • Okta
  • Repute
  • Workable
  • Zoho People

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

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_limit
boolean

Ignores the limit query parameter.

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
  • cost-center
  • department
  • division
  • group
  • office
  • org-unit
  • organization
  • team
Enum support by integration
  • Officient
    • department
    • team
  • Kenjo
    • department
    • team
  • HeavenHR
    • organization
    • cost-center
  • Breathe
    • department
    • division
  • AlexisHR
    • department
    • office
    • team
    • cost-center
  • Hailey HR
    • department
    • team
Required in
  • AlexisHR
  • Breathe
  • Hailey HR
  • HeavenHR
  • Kenjo
  • Officient
name
string

Group's name

Supported in
  • IntelliHR
  • JumpCloud
  • Kenjo
company_id
string

The company ID you want to get the groups for

Required in
  • Gusto

Response Body ​

result
object[]

List of Groups

id
string
REQUIRED · 

The unique identifier for groups

Supported in
  • AlexisHR
  • Breathe
  • Charlie
  • ClayHR
  • Factorial
  • Google Workspace
  • greytHR
  • Gusto
  • Hailey HR
  • HeavenHR
  • HiBob
  • HR Cloud
  • HR Partner
  • IntelliHR
  • JumpCloud
  • Keka
  • Kenjo
  • Namely
  • Officient
  • Okta
  • Repute
  • Workable
  • Zoho People
parent_group
string

Parent Group of this group

Supported in
  • AlexisHR
  • ClayHR
  • IntelliHR
  • Workable
  • Zoho People
name
string

Group's name

Supported in
  • AlexisHR
  • Breathe
  • Charlie
  • ClayHR
  • Factorial
  • Google Workspace
  • greytHR
  • Gusto
  • Hailey HR
  • HeavenHR
  • HiBob
  • HR Cloud
  • HR Partner
  • IntelliHR
  • JumpCloud
  • Keka
  • Kenjo
  • Namely
  • Officient
  • Okta
  • Repute
  • Workable
  • Zoho People
description
string

Short description of the group

Supported in
  • AlexisHR
  • ClayHR
  • Factorial
  • Google Workspace
  • IntelliHR
  • JumpCloud
  • Keka
  • Namely
  • Officient
  • 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
Supported in
  • AlexisHR
  • Breathe
  • Charlie
  • ClayHR
  • Factorial
  • Gusto
  • Hailey HR
  • HeavenHR
  • HiBob
  • HR Partner
  • IntelliHR
  • JumpCloud
  • Kenjo
  • Namely
  • Officient
  • Okta
  • Repute
  • Zoho People
created_at
string · date-time

This represents the date when the groups was created

Supported in
  • AlexisHR
  • Breathe
  • Okta
  • Zoho People
updated_at
string · date-time

This represents the date when the groups was updated

Supported in
  • AlexisHR
  • Breathe
  • Okta
  • Zoho People
remote_data
object

Raw data returned from the remote API call.

next_cursor
string

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.