Types

Group

A group of users, led by one user and optionally under a parent group.

idrequired
string (uuid)
The group id.
namerequired
string
The group's name.
descriptionrequired
string | null
The group's description.
lead_user_idrequired
string | null (uuid)
The group's lead, a user of your organisations. Null for a group that has no lead. A user can lead only one group.
parent_idrequired
string | null (uuid)
The group this group sits under. Null for a root group. Changing it moves the group and its descendants.
member_countrequired
integer
How many users of your organisations are members, not counting the lead. Read-only.
featuresrequired
object
Every feature flag and whether it is on for the group. A PATCH changes only the flags it names.
created_atrequired
string | null (date-time)
When the group was created.
updated_atrequired
string | null (date-time)
When the group last changed.

Used by (4)