Rippling: List supergroups — response body — results item
List supergroups: response body, field results / item. Complete fields and constraints for contract 2026-10-28.
API reference · Contract 2026-10-28
SDK schema: List supergroups — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
allow_non_employees | boolean | Optional | Whether the group allows non employees |
app_owner_id | string | Optional | The id of the group’s app owner. |
can_override_role_states | boolean | Optional | Whether the group can override role states |
created_at | string | Required within parent | Record creation date |
cumulatively_exhaustive_default | boolean | Optional | Whether the group is the cumulatively exhaustive default |
description | string | Optional | The group’s description. |
display_name | string | Optional | The group’s display name. |
group_type | string | Optional | The group type |
id | string | Required within parent | Identifier field |
ignore_prov_group_matching | boolean | Optional | Whether to ignore provisioning group matching when determining group membership |
include_terminated | boolean | Optional | Whether the group include terminated roles |
is_invisible | boolean | Optional | Whether the group is invisible |
mutually_exclusive_key | string | Optional | The group’s mutually exclusive key |
name | string | Optional | The group’s name. |
parent | string | Optional | The group’s parent. |
priority | JSON | Optional | |
priority (anyOf 1) | integer | Alternative | The group’s priority when calculating mutual exclusivity |
priority (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
read_only | boolean | Optional | Whether the group is read only. |
sub_group_type | string | Optional | The sub group type |
updated_at | string | Required within parent | Record update date |