Skip to content

List Groups

Endpoint

http
GET /unified/hris/groups
Integrations supported
  • Google Workspace
  • greytHR
  • HR Cloud
  • Okta
  • Repute

Query parameters

integrated_account_id
string · uuid
REQUIRED · The ID of the integrated account to use for the request.
Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d

Response Body

result
object[]
List of Groups
id
string
REQUIRED · The unique identifier for groups
Supported in
  • Google Workspace
  • greytHR
  • HR Cloud
  • Okta
  • Repute
parent_group
string
Parent Group of this group
name
string
Group's name
Supported in
  • Google Workspace
  • greytHR
  • HR Cloud
  • Okta
  • Repute
description
string
Short description of the group
Supported in
  • Google Workspace
  • Okta
type
string
Type of the group. Some underlying providers use this to differentiate between in-built and user created groups.
Supported in
  • Okta
  • Repute
created_at
string
This represents the date when the groups was created
Supported in
  • Okta
updated_at
string
This represents the date when the groups was updated
Supported in
  • Okta
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.