Classic APIs
ClassicGroupsApi
groupPermissionsForRole

groupPermissionsForRole

Gets permissions for a role in a group.

Parameters

NameTypeDescription
groupIdGroupIdThe id of the group.
roleSetIdRoleSetIdThe id of the role to get permissions for.

Example

const { data: rolePerms } = await ClassicGroupsApi.groupPermissionsForRole({ groupId: 5850082, roleSetId: 38353814 }); 

Example Data

{
  groupId: 5850082,
  role: {
    id: 38353814,
    name: "Guest",
    description: "A non-group member.",
    rank: 0,
  },
  permissions: {
    groupPostsPermissions: {
      viewWall: true,
      postToWall: false,
      deleteFromWall: false,
      viewStatus: false,
      postToStatus: false,
    },
    groupMembershipPermissions: {
      changeRank: false,
      inviteMembers: false,
      removeMembers: false,
    },
    groupManagementPermissions: {
      manageRelationships: false,
      manageClan: false,
      viewAuditLogs: false,
    },
    groupEconomyPermissions: {
      spendGroupFunds: false,
      advertiseGroup: false,
      createItems: false,
      manageItems: false,
      addGroupPlaces: false,
      manageGroupGames: false,
      viewGroupPayouts: false,
      viewAnalytics: false,
    },
    groupOpenCloudPermissions: {
      useCloudAuthentication: false,
      administerCloudAuthentication: false,
    },
  },
} 

Endpoint

GET /v1/groups/{groupId}/roles/{roleSetId}/permissions