Group — cloud.docs

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

Properties

Name	Type	Required	Description
path	string	false	The resource path of the group. Format: `groups/{group_id}`
createTime	string	false	The timestamp when the group was created.
updateTime	string	false	The timestamp when the group was last updated.
id	string	false	A unique ID that identifies the group.
displayName	string	false	The name of the group. Must be non-empty. Has a maximum limit of 50 characters.
description	string	false	The description of the group. Has a maximum limit of 1000 characters.
owner	string	false	The resource path of the owner. If the group is abandoned and has no owner, this field is not returned.
memberCount	integer	false	The total number of members within a group.
publicEntryAllowed	boolean	false	Whether the group allows public entry.
locked	boolean	false	Whether the group is locked. A locked group is a group that has been moderated/banned by Roblox.
verified	boolean	false	Whether the group has the verified badge.

Complete Schema

{
  "type": "object",
  "properties": {
    "path": {
      "example": "groups/123",
      "type": "string",
      "description": "The resource path of the group.\n\nFormat: `groups/{group_id}`"
    },
    "createTime": {
      "readOnly": true,
      "example": "2023-07-05T12:34:56Z",
      "type": "string",
      "description": "The timestamp when the group was created.",
      "format": "date-time"
    },
    "updateTime": {
      "readOnly": true,
      "example": "2023-07-05T12:34:56Z",
      "type": "string",
      "description": "The timestamp when the group was last updated.",
      "format": "date-time"
    },
    "id": {
      "readOnly": true,
      "example": "7",
      "type": "string",
      "description": "A unique ID that identifies the group."
    },
    "displayName": {
      "example": "Roblox",
      "type": "string",
      "description": "The name of the group.\n\nMust be non-empty. Has a maximum limit of 50 characters."
    },
    "description": {
      "example": "Official fan club of Roblox!",
      "type": "string",
      "description": "The description of the group.\n\nHas a maximum limit of 1000 characters."
    },
    "owner": {
      "readOnly": true,
      "example": "users/21557",
      "type": "string",
      "description": "The resource path of the owner.\n\nIf the group is abandoned and has no owner, this field is not returned."
    },
    "memberCount": {
      "readOnly": true,
      "example": 10196297,
      "type": "integer",
      "description": "The total number of members within a group.",
      "format": "int32"
    },
    "publicEntryAllowed": {
      "example": true,
      "type": "boolean",
      "description": "Whether the group allows public entry."
    },
    "locked": {
      "readOnly": true,
      "example": true,
      "type": "boolean",
      "description": "Whether the group is locked.\n\nA locked group is a group that has been\nmoderated/banned by Roblox."
    },
    "verified": {
      "readOnly": true,
      "example": true,
      "type": "boolean",
      "description": "Whether the group has the verified badge."
    }
  },
  "description": "A mini-community within Roblox for communication, discussions, and more.",
  "x-aep-resource": {
    "patterns": [
      "groups/{group_id}"
    ],
    "plural": "groups",
    "singular": "group"
  },
  "x-resource": true,
  "x-oneOf": {
    "Owner": [
      "owner"
    ]
  }
}