queryJoinGroupRequests( )

Creates a query to retrieve a list of join requests.


  • This function is only relevant for private groups.
  • For SECRET groups, only site admins and group admins can query requests to join their group.

The queryjoinGroupRequests() function builds a query to retrieve a list of all requests to join a group, and returns a JoinGroupRequestsQueryBuilder object.

The returned object contains the query definition which is typically used to run the query using the find() function.

You can refine the query by chaining joinGroupRequestsQueryBuilder functions onto the query. joinGroupRequestsQueryBuilder functions enable you to sort, filter, and control the results that queryjoinGroupRequests() returns.

The results of the queryjoinGroupRequests() function are sorted by _createdDate in descending order.

queryjoinGroupRequests() runs with this joinGroupRequestsQueryBuilder default, which you can override:

The following joinGroupRequestsQueryBuilder functions are supported for queryjoinGroupRequests(). For a full description of the joinGroupRequests object, see the object returned for the items property in JoinGroupRequestsQueryResult.

PropertySupported Filters & Sorting
statuseq(), ne(), hasSome(), or()
Admin Method

This function requires elevated permissions and runs only on the backend and on dashboard pages.

Method Declaration
Method Parameters

Group ID.

Was this helpful?