1 min read

Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.

GroupJoinRequest — openapi

A request to join a group.

The acceptRequests permission is required.

Properties

NameTypeRequiredDescription
pathstringfalseThe resource path of the group join request. Format: groups/{group_id}/join-requests/{group_join_request_id}
createTimestringfalseThe timestamp when the group join request was created.
userstringfalseThe resource path of the user.

Complete Schema

{
  "type": "object",
  "properties": {
    "path": {
      "example": "groups/123/join-requests/123",
      "type": "string",
      "description": "The resource path of the group join request.\n\nFormat: `groups/{group_id}/join-requests/{group_join_request_id}`"
    },
    "createTime": {
      "readOnly": true,
      "example": "2023-07-05T12:34:56Z",
      "type": "string",
      "description": "The timestamp when the group join request was created.",
      "format": "date-time"
    },
    "user": {
      "readOnly": true,
      "example": "users/156",
      "type": "string",
      "description": "The resource path of the user."
    }
  },
  "description": "A request to join a group.\n\nThe `acceptRequests` permission is required.",
  "x-aep-resource": {
    "patterns": [
      "groups/{group_id}/join-requests/{group_join_request_id}"
    ],
    "plural": "group-join-requests",
    "singular": "group-join-request"
  },
  "x-resource": true
}