ROroblox
Groups

Get Group

Gets the specified group.

get/cloud/v2/groups/{group_id}

Request

  • Base URL
    https://apis.roblox.com
  • URL
    https://apis.roblox.com/cloud/v2/groups/{group_id}
  • Auth
    • API key in header x-api-key
    • or OAuth 2
      Authorization code: https://apis.roblox.com/oauth/v1/authorize
      Token URL: https://apis.roblox.com/oauth/v1/token

Path parameters

group_idstring required

The group ID.

Response

OK

pathstring

The resource path of the group.

Format: groups/{group_id}

createTimestring date-time

The timestamp when the group was created.

updateTimestring date-time

The timestamp when the group was last updated.

idstring

A unique ID that identifies the group.

displayNamestring

The name of the group.

Must be non-empty. Has a maximum limit of 50 characters.

descriptionstring

The description of the group.

Has a maximum limit of 1000 characters.

ownerstring

The resource path of the owner.

If the group is abandoned and has no owner, this field is not returned.

memberCountinteger

The total number of members within a group.

publicEntryAllowedboolean

Whether the group allows public entry.

lockedboolean

Whether the group is locked.

A locked group is a group that has been moderated/banned by Roblox.

verifiedboolean

Whether the group has the verified badge.

Example response

{
  "path": "groups/123",
  "createTime": "2023-07-05T12:34:56Z",
  "updateTime": "2023-07-05T12:34:56Z",
  "id": "7",
  "displayName": "Roblox",
  "description": "Official fan club of Roblox!",
  "owner": "users/21557",
  "memberCount": 10196297,
  "publicEntryAllowed": true,
  "locked": true,
  "verified": true
}

Changes

No recorded changes to this operation across all 33 revisions of this API.