listGroups( )


Lists groups.

The listGroups() function returns a Promise that resolves to a list of up to 1,000 groups on your site. Sorts by default to _createdDate in descending order.

Notes:

  • For SECRET groups, only site admins, group admins, and group members can see a list of group and their content.
  • This function's parameters are positional, and must be specified in the sequence shown in the syntax below. When specifying a parameter, use null as a placeholder for any unspecified parameters. For example, to specify limit only, call listGroups(paging, null).
Method Declaration
Copy
function listGroups(options: ListGroupsOptions): Promise<ListGroupsResponse>;
Method Parameters
optionsListGroupsOptions

Limit and offset options.

Returns
Return Type:Promise<ListGroupsResponse>
JavaScript
import { groups } from "wix-groups.v2"; async function listGroups(options) { try { const result = await groups.listGroups(options); return result; } catch (error) { console.error(error); // Handle the error } }
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?