Group

A mini-community within Roblox for communication, discussions, and more.

Attributes

pathstring

The resource path of the group.

Format: groups/{group_id}.

createTimestring
Output Only

The timestamp when the group was created. This string is formatted as a Timestamp.

updateTimestring
Output Only

The timestamp when the group was last updated. This string is formatted as a Timestamp.

idstring
Output Only

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
Output Only

The resource path of the owner.

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

memberCountnumber
Output Only

The total number of members within a group.

publicEntryAllowedboolean

Whether the group allows public entry.

lockedboolean
Output Only

Whether the group is locked.

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

verifiedboolean
Output Only

Whether the group has the verified badge.

Base URL

https://apis.roblox.com
The Group Resource

{
"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
}

Group

Get Group
Beta

GET /cloud/v2/groups/{group_id}

Gets the specified group.

RequestPath Parameters
group_idstring
Required

The group ID.

ResponseGroup
GET /cloud/v2/groups/{group_id}

curl -L -X GET 'https://apis.roblox.com/cloud/v2/groups/{group_id}' \
-H 'x-api-key: {your-api-key}'
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
}