GroupJoinRequest

A request to join a group.

The acceptRequests permission is required.

Attributes

pathstring

The resource path of the group join request.

Format: groups/{group_id}/join-requests/{group_join_request_id}.

createTimestring
Output Only

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

userstring
Output Only

The resource path of the user.

Base URL
https://apis.roblox.com
The GroupJoinRequest Resource
{

  "path": "groups/123/join-requests/123",

  "createTime": "2023-07-05T12:34:56Z",

  "user": "users/156"

}

GroupJoinRequest

List Group Join Requests
Beta

GET /cloud/v2/groups/{group_id}/join-requests

List join requests under a group.

Scopes
group:read
RequestPath Parameters
group_idstring
Required

The group ID.

Query Parameters
maxPageSizenumber

The 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.

pageTokenstring

A 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.

filterstring

This 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'".

Response

A list of GroupJoinRequests in the parent collection.

groupJoinRequestsarray<GroupJoinRequest>

The GroupJoinRequests from the specified Group.

nextPageTokenstring

A token that you can send as a pageToken parameter to retrieve the next page. If this field is omitted, there are no subsequent pages.

GET /cloud/v2/groups/{group_id}/join-requests
curl -L -X GET 'https://apis.roblox.com/cloud/v2/groups/{group_id}/join-requests?maxPageSize=10&pageToken={string}&filter={string}' \

  -H 'x-api-key: {your-api-key}'
Response
{

  "groupJoinRequests": [

    {

      "path": "groups/123/join-requests/123",

      "createTime": "2023-07-05T12:34:56Z",

      "user": "users/156"

    }

  ],

  "nextPageToken": "string"

}

GroupJoinRequest

Accept Group Join Request
Beta

POST /cloud/v2/groups/{group_id}/join-requests/{join_request_id}:accept

Accepts a join request.

Scopes
group:write
RequestPath Parameters
group_idstring
Required

The group ID.

join_request_idstring
Required

The join-request ID.

Request Body
POST /cloud/v2/groups/{group_id}/join-requests/{join_request_id}:accept
curl -L -X POST 'https://apis.roblox.com/cloud/v2/groups/{group_id}/join-requests/{join_request_id}:accept' \

  -H 'x-api-key: {your-api-key}' \

  -H 'Content-Type: application/json' \

  --data '{}'

GroupJoinRequest

Decline Group Join Request
Beta

POST /cloud/v2/groups/{group_id}/join-requests/{join_request_id}:decline

Declines a join request.

Scopes
group:write
RequestPath Parameters
group_idstring
Required

The group ID.

join_request_idstring
Required

The join-request ID.

Request Body
POST /cloud/v2/groups/{group_id}/join-requests/{join_request_id}:decline
curl -L -X POST 'https://apis.roblox.com/cloud/v2/groups/{group_id}/join-requests/{join_request_id}:decline' \

  -H 'x-api-key: {your-api-key}' \

  -H 'Content-Type: application/json' \

  --data '{}'