Sign in
Groups

List Group Join Requests

List join requests under a group. Supports filtering.

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

Path parameters

group_idstring required

The group ID.

Query parameters

maxPageSizeinteger

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

OK

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.

Example response

{
  "groupJoinRequests": [
    {
      "path": "groups/123/join-requests/123",
      "createTime": "2023-07-05T12:34:56Z",
      "user": "users/156"
    }
  ]
}

Changes

No recorded changes to this endpoint across all 20 revisions of this API.