listGroupRequests( )


Developer Preview

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

Lists requests to create a group.

The listGroupRequests() function returns a Promise that resolves to a list of up to 1,000 create group requests on your site.

Using the options parameter, you can filter your list of posts, set the amount of posts to be returned, and sort your list in a specified order.

By default, the list is sorted by _createdDate in descending order. Only admins can see create group requests. Members can access their own create group requests in their site.

Note: This function is only relevant if admin approval is required for creating a group.

Admin Method

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

Method Declaration
Copy
Method Parameters
optionsListGroupRequestsOptions

Paging options.

Returns
Return Type:Promise<ListGroupRequestsResponse>
Was this helpful?
Yes
No