queryGroupRequests( )


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Creates a query to retrieve a list of create requests.

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

queryGorupRequests() runs with these GroupRequestsQueryBuilder defaults, which you can override:

The following GroupRequestsQueryBuilder functions are supported for queryGroupRequests(). For a full description of the GroupRequests object, see the object returned for the items property in GroupRequestsQueryResult.

PROPERTYSUPPORTED FILTERS & SORTING
statuseq(),ne(),exists(),in(),hasSome()
Admin Method

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

Method Declaration
Copy
Method Parameters
optionsQueryGroupRequestsOptions
Returns
Was this helpful?
Yes
No