pub struct GroupType {Show 15 fields
pub available_for_new_person: bool,
pub color: String,
pub description: Option<String>,
pub is_leader_necessary: bool,
pub name: String,
pub name_plural: String,
pub permission_depth: i64,
pub posts_enabled: bool,
pub shorty: String,
pub sort_key: i64,
pub id: i64,
pub meta: GroupTypeMeta,
pub name_plural_translated: String,
pub name_translated: String,
pub extra: Map<String, Value>,
}Expand description
A configurable type shared by groups, such as small groups or ministry teams. It defines common settings and the set of membership roles available to those groups. A group references its type through information.groupTypeId; a membership role describes a person’s function within a group, such as leader or participant.
Fields§
§available_for_new_person: boolWhether eligible groups of this type are offered for membership selection when creating a person in the ChurchTools UI. This does not automatically add the person to a group or grant membership permissions.
color: StringChurchTools color token used to display this group type; not a hexadecimal color code.
Allowed values: accent, amber, basic, blue, constructive, critical, cyan, destructive, emerald, error, fuchsia, gray, green, indigo, info, lime, magic, orange, pink, purple, red, rose, sky, success, teal, violet, warning, yellow.
description: Option<String>Optional explanatory text for this group type. Returned as null when no description is stored.
is_leader_necessary: boolWhether groups of this type are expected to retain a leader. The ChurchTools UI uses this setting when removing leaders or deactivating leader roles.
name: StringStored singular name of the group type. Use nameTranslated from the response for a localized display name.
name_plural: StringStored plural name of the group type. Use namePluralTranslated from the response for a localized display name.
permission_depth: i64Number of child-group levels to which permissions configured for this group type are inherited. 0 disables inheritance to child groups; 1 includes direct children. This setting does not itself grant permissions.
posts_enabled: boolWhether posts are enabled for groups of this type. Access to individual groups and posts still depends on permissions.
shorty: StringShort label used to identify this group type in compact displays.
sort_key: i64Display order of the group type. Lower values come first; this endpoint sorts equal values by the stored name.
id: i64ID of the group type in this ChurchTools installation. Use this ID when referencing the type from a group or role.
meta: GroupTypeMetaCreation and last modification timestamps and person IDs for this group type.
name_plural_translated: StringPlural display name translated into the current language, if a translation exists.
name_translated: StringSingular display name translated into the current language, if a translation exists.
extra: Map<String, Value>Fields not described by the spec, e.g. instance-specific DB fields.