queryJoinRequests( )

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. However, if the suppressAuth option is set to true, all permissions are overwritten, and all site members (including non-group members) can query requests to join a group.

The queryJoinRequests() function builds a query to retrieve a list of all requests to join a group, and returns a JoinRequestsQueryBuilder 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 JoinRequestsQueryBuilder functions onto the query. JoinRequestsQueryBuilder functions enable you to sort, filter, and control the results that queryJoinRequests() returns.

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

queryJoinRequests() runs with this JoinRequestsQueryBuilder default, which you can override:

The following JoinRequestsQueryBuilder functions are supported for queryJoinRequests(). For a full description of the JoinRequests object, see the object returned for the items property in JoinRequestsQueryResult.

PropertySupported Filters & Sorting
statuseq(), ne(), hasSome(), or()
Method Declaration
This method does not take any parameters
Was this helpful?