Skip to content

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

FieldTypePresenceDescription and constraints
$objectRoot
allow_non_employeesbooleanOptionalWhether the group allows non employees
app_owner_idstringOptionalThe id of the group’s app owner.
can_override_role_statesbooleanOptionalWhether the group can override role states
created_atstringRequired within parentRecord creation date
cumulatively_exhaustive_defaultbooleanOptionalWhether the group is the cumulatively exhaustive default
descriptionstringOptionalThe group’s description.
display_namestringOptionalThe group’s display name.
group_typestringOptionalThe group type
idstringRequired within parentIdentifier field
ignore_prov_group_matchingbooleanOptionalWhether to ignore provisioning group matching when determining group membership
include_terminatedbooleanOptionalWhether the group include terminated roles
is_invisiblebooleanOptionalWhether the group is invisible
mutually_exclusive_keystringOptionalThe group’s mutually exclusive key
namestringOptionalThe group’s name.
parentstringOptionalThe group’s parent.
priorityJSONOptional
priority (anyOf 1)integerAlternativeThe group’s priority when calculating mutual exclusivity
priority (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
read_onlybooleanOptionalWhether the group is read only.
sub_group_typestringOptionalThe sub group type
updated_atstringRequired within parentRecord update date

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.