Sign in
Groups

Gets the Group's settings

get/legacy-groups/v1/groups/{groupId}/settings

Path parameters

groupIdinteger required

The id of the group the user is in.

Response

OK

isApprovalRequiredboolean

Whether public entry is allowed.

isBuildersClubRequiredboolean

Whether Builder's Club is required.

areEnemiesAllowedboolean

Whether enemy club declarations are allowed.

areGroupFundsVisibleboolean

Whether funds are publicly visible.

areGroupGamesVisibleboolean

Whether games are publicly visible.

isGroupNameChangeEnabledboolean

If the group name change feature is enabled for this group.

verificationLevel0 | 1 | 2 | 3

The verification level for the group. Null if the verification level could not be determined due to an error.

accountTenureRequirement0 | 1 | 2 | 3 | 4 | 5

The account tenure requirement for the group. Null if the account tenure requirement could not be determined due to an error.

slowmode0 | 1 | 2 | 3

The slowmode level for the group (0-4). 0 = No slowmode, 1-4 = Slowmode levels with increasing restrictions.

isMemberListVisibleToPublicboolean

Whether the group member list is visible to public.

isAutoAssignRoleDisabledboolean

Whether automatic assignment of the lowest non-guest role is disabled for this group. For non-legacy groups (created after the multi-role cutoff), this is always true. For legacy groups, reflects the persisted GroupFeatureSettings value. Null when the value could not be determined.

Changes

Changed in 1 of the 12 revisions of this API.2

  • 958b2b40425d2See the full diff
    • ○

      added the optional property communityTier/capabilities to the response with the 200 status (media type: application/json)

      response-optional-property-added

    • ○

      added the optional property communityTier/capabilities to the response with the 200 status (media type: text/json)

      response-optional-property-added