Group#
This object is not returned by any endpoints yet. It is here only as a reference for UserGroup.
| Field |
Type |
Description |
| colour |
string? |
|
| has_listing |
boolean |
Whether this group displays a listing at /groups/{id}. |
| has_playmodes |
boolean |
Whether this group associates Rulesets with users' memberships. |
| id |
integer |
|
| identifier |
string |
Unique string to identify the group. |
| is_probationary |
boolean |
Whether members of this group are considered probationary. |
| name |
string |
|
| short_name |
string |
Short name of the group for display. |
Optional Attributes#
The following are attributes which may be additionally included in responses. Relevant endpoints should list them if applicable.
Description#
| Field |
Type |
| html |
string |
| markdown |
string |