---
title: "Gets a list of all group roles for groups the specified user is in."
method: GET
path: "/v1/users/{userId}/groups/roles"
tags: ["Groups", "Users"]
---

# Gets a list of all group roles for groups the specified user is in.

`GET /v1/users/{userId}/groups/roles`

## Path parameters

- `userId` integer, required

## Query parameters

- `includeLocked` boolean
- `includeNotificationPreferences` boolean
- `discoveryType` 0 | 1 | 2

## Response `200`

OK

- RobloxWebWebAPIModelsApiArrayResponseRobloxGroupsApiGroupMembershipDetailResponse
  - `data` RobloxGroupsApiGroupMembershipDetailResponse[]
    - `group` RobloxGroupsApiGroupDetailResponse — A detailed group response model
      - `id` integer — The group id
      - `name` string — The group name
      - `description` string — The group description
      - `owner` RobloxGroupsApiModelsResponseUserModel — A model representing data about an Roblox.Platform.Membership.IUser
        - `buildersClubMembershipType` 0 | 1 | 2 | 3 | 4 — The user's builders club membership type
        - `hasVerifiedBadge` boolean — The user's verified badge status.
        - `userId` integer
        - `username` string
        - `displayName` string
      - `shout` RobloxGroupsApiShoutResponse
        - `body` string — The shout's message
        - `poster` RobloxGroupsApiModelsResponseUserModel — A model representing data about an Roblox.Platform.Membership.IUser
          - `buildersClubMembershipType` 0 | 1 | 2 | 3 | 4 — The user's builders club membership type
          - `hasVerifiedBadge` boolean — The user's verified badge status.
          - `userId` integer
          - `username` string
          - `displayName` string
        - `created` string, date-time — The shout's created time
        - `updated` string, date-time — The shout's last updated time
      - `memberCount` integer — The number of members in the group
      - `isBuildersClubOnly` boolean — Whether the group is Builders Club only
      - `publicEntryAllowed` boolean — Whether the group is public (no approval required)
      - `isLocked` boolean — Whether the group is locked
      - `hasVerifiedBadge` boolean — Whether the group has a verified badge.
      - `hasSocialModules` boolean — Whether the group has social modules enabled (e.g. Forums) (determines if "Followers" vs "Members" should be shown).
      - `communityTier` RobloxGroupsClientCommunityTierInfoResponse
        - `groupId` integer
        - `currentTier` integer
        - `previousTier` integer
        - `tierUpdatedTime` string, date-time
        - `lastEvaluatedTime` string, date-time
        - `requirements` RobloxGroupsClientTierRequirement[]
          - `key` 1 | 2 | 3 | 4 | 5 — ['OwnerModerationStatusOk' = 1, 'OwnerAgeEstimationVerified' = 2, 'OwnerIdVerified' = 3, 'OwnerTwoStepVerified' = 4, 'CommunityMeetsPlayerRequirement' = 5]
          - `satisfied` boolean
    - `role` RobloxGroupsApiGroupRoleResponse — A group role response model
      - `id` integer — The role id
      - `name` string — The role name
      - `description` string — The role description
      - `rank` integer — The role rank
      - `memberCount` integer — The number of members in the role.
      - `isBase` boolean — Whether or not the role is the base role for the group
      - `color` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 — The role color. ['Invalid' = 0, 'Blue' = 1, 'Green' = 2, 'Purple' = 3, 'Yellow' = 4, 'Orange' = 5, 'Red' = 6, 'Magenta' = 7, 'Teal' = 8, 'Turquoise' = 9, 'Rust' = 10, 'Pistachio' = 11, 'Midnight' = 12, 'Lavender' = 13, 'Pink' = 14, 'Crimson' = 15, 'Plum' = 16]
    - `isPrimaryGroup` boolean — Whether the group is the user's Primary Group
    - `isNotificationsEnabled` boolean — Whether the group notification preferences are enabled for the user
    - `notificationPreferences` RobloxGroupsApiGroupNotificationPreferenceData[]
      - `type` 0 | 1 | 2 | 3 | 4 — ['AnnouncementCreatedNotification' = 0, 'ForumPostCreatedNotification' = 1, 'ForumCommentCreatedNotification' = 2, 'ForumCommentReplyCreatedNotification' = 3, 'ForumSubscriberNotification' = 4]
      - `enabled` boolean
      - `name` string
      - `description` string

## Other responses

- `400` — 3: The user is invalid or does not exist.

---

[API](https://skmtc.net/roblox/apis/roblox-api.md) · [All operations](https://skmtc.net/roblox/apis/roblox-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/roblox/roblox-api/versions/e15802062270/schema)