3 min read

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

GET /cloud/v2/groups/{group_id}/join-requests — cloud.docs

List Group Join Requests

List join requests under a group. Supports filtering.

Endpoint

Method: GET

Path: /cloud/v2/groups/{group_id}/join-requests

Servers:

Parameters

NameLocationRequiredDescription
group_idpathtrueThe group ID.
maxPageSizequeryfalseThe maximum number of group join requests to return. The service might return fewer than this value. If unspecified, at most 10 group join requests are returned. The maximum value is 20 and higher values are set to 20.
pageTokenqueryfalseA page token, received from a previous call, to retrieve a subsequent page. When paginating, all other parameters provided to the subsequent call must match the call that provided the page token.
filterqueryfalseThis field may be set in order to filter the resources returned. Filtering conforms to Common Expression Language (CEL). Only the user field and == operator are supported. Example: "user == 'users/156'"
[
  {
    "name": "group_id",
    "in": "path",
    "description": "The group ID.",
    "required": true,
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "maxPageSize",
    "in": "query",
    "description": "The maximum number of group join requests to return. The service might\nreturn fewer than this value. If unspecified, at most 10 group join\nrequests are returned. The maximum value is 20 and higher values are set\nto 20.",
    "schema": {
      "type": "integer",
      "format": "int32"
    },
    "examples": {
      "maxPageSize": {
        "description": "An integer between 1 and 20, inclusive",
        "value": 10
      }
    }
  },
  {
    "name": "pageToken",
    "in": "query",
    "description": "A page token, received from a previous call, to retrieve a subsequent page.\n\nWhen paginating, all other parameters provided to the subsequent call must\nmatch the call that provided the page token.",
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "filter",
    "in": "query",
    "description": "This field may be set in order to filter the resources returned.\n\nFiltering conforms to Common Expression Language (CEL). Only the `user`\nfield and `==` operator are supported.\n\n\nExample: `\"user == 'users/156'\"`",
    "schema": {
      "type": "string"
    }
  }
]

Responses

StatusDescription
200OK
{
  "200": {
    "description": "OK",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/ListGroupJoinRequestsResponse"
        }
      }
    }
  }
}

Authentication

{
  "security": [],
  "securitySchemes": {}
}

Complete Operation Definition

{
  "tags": [
    "Cloud"
  ],
  "summary": "List Group Join Requests",
  "description": "List join requests under a group. Supports filtering.",
  "operationId": "Cloud_ListGroupJoinRequests",
  "parameters": [
    {
      "name": "group_id",
      "in": "path",
      "description": "The group ID.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "maxPageSize",
      "in": "query",
      "description": "The maximum number of group join requests to return. The service might\nreturn fewer than this value. If unspecified, at most 10 group join\nrequests are returned. The maximum value is 20 and higher values are set\nto 20.",
      "schema": {
        "type": "integer",
        "format": "int32"
      },
      "examples": {
        "maxPageSize": {
          "description": "An integer between 1 and 20, inclusive",
          "value": 10
        }
      }
    },
    {
      "name": "pageToken",
      "in": "query",
      "description": "A page token, received from a previous call, to retrieve a subsequent page.\n\nWhen paginating, all other parameters provided to the subsequent call must\nmatch the call that provided the page token.",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "filter",
      "in": "query",
      "description": "This field may be set in order to filter the resources returned.\n\nFiltering conforms to Common Expression Language (CEL). Only the `user`\nfield and `==` operator are supported.\n\n\nExample: `\"user == 'users/156'\"`",
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ListGroupJoinRequestsResponse"
          }
        }
      }
    }
  },
  "x-visibility": "BETA",
  "x-roblox-engine-usability": {
    "apiKeyWithHttpService": true
  },
  "x-roblox-scopes": [
    {
      "name": "group:read"
    }
  ],
  "x-roblox-docs": {
    "category": "Users and groups",
    "methodProperties": {
      "scopes": [
        "group:read"
      ]
    },
    "resource": {
      "$ref": "#/components/schemas/GroupJoinRequest",
      "name": "GroupJoinRequest"
    }
  }
}