{"id":"0b86749e-6baf-4dc8-b5f7-1493ddcbe1ce","createdDate":"2024-06-30T07:59:51.229Z","updatedDate":"2024-06-30T07:59:51.229Z","resourceId":"904fda99-f1e7-4745-b811-ef282a411cb2","sdk":{"schema":{"name":"velo-deps_wix-groups.v2_groups","fqn":"","slug":"velo-deps-wix-groups-v2-groups","typesMap":{"Group":{"name":"Group","fqn":"Group","slug":"group","actions":[],"properties":[{"name":"_createdDate","slug":"created-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Group creation date and time."},{"name":"_id","slug":"id","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Group ID."},{"name":"_updatedDate","slug":"updated-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time of the latest group update."},{"name":"coverImage","slug":"cover-image","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CoverImage","referenceFqn":"CoverImage"},"description":"Cover image. You cannot upload your own cover image."},{"name":"description","slug":"description","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Group description in DraftJS format."},{"name":"lastActivityDate","slug":"last-activity-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time of the most recent group activity, for example a post or comment."},{"name":"memberTitle","slug":"member-title","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"What group members are called, for example `Coworkers`, `Friends`, or `Students`."},{"name":"membersCount","slug":"members-count","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Total count of current group members."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Group name."},{"name":"ownerId","slug":"owner-id","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Group owner."},{"name":"privacyStatus","slug":"privacy-status","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PrivacyStatus","referenceFqn":"PrivacyStatus"},"description":"Group privacy status.\n- `PUBLIC` - Anyone can see the group and its content. Anyone can join the group.\n- `PRIVATE` - Anyone can see the group, but only members can see its content. New member must submit a `Join Group Request`.\n- `SECRET` - Only admins and members can see the group. New members can only be added by other members."},{"name":"settings","slug":"settings","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"GroupSettings","referenceFqn":"GroupSettings"},"description":"Group specific settings. Available to the site owners under `Admin Tools` in the dashboard."},{"name":"slug","slug":"slug","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"A unique part of a group's URL, for example `https:/example.com/groups/slug`."},{"name":"teaser","slug":"teaser","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Group teaser."}]},"AccessRestriction":{"name":"AccessRestriction","fqn":"AccessRestriction","slug":"access-restriction","actions":[],"oneofProperties":{"data":[{"name":"events","slug":"events","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Events","referenceFqn":"Events"}}]},"properties":[{"name":"type","slug":"type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Type","referenceFqn":"Type"}}]},"Events":{"name":"Events","fqn":"Events","slug":"events","actions":[],"properties":[{"name":"eventIds","slug":"event-ids","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}}}]},"Type":{"name":"Type","fqn":"Type","slug":"type","actions":[],"enumValues":["ADMIN_APPROVAL","EVENTS","PAID_PLANS","UNKNOWN"],"properties":[]},"CoverImage":{"name":"CoverImage","fqn":"CoverImage","slug":"cover-image","actions":[],"properties":[{"name":"image","slug":"image","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Image","referenceFqn":"Image"},"description":"Cover image."},{"name":"mobilePosition","slug":"mobile-position","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Position","referenceFqn":"Position"},"description":"Position of the corner of the cover image (or logo) for mobile browser."},{"name":"position","slug":"position","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Position","referenceFqn":"Position"},"description":"Position of the corner of the cover image (or logo)."}]},"Image":{"name":"Image","fqn":"Image","slug":"image","actions":[],"properties":[{"name":"height","slug":"height","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Image height."},{"name":"mediaId","slug":"media-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Image ID (for internal use)."},{"name":"width","slug":"width","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Image width."}]},"Position":{"name":"Position","fqn":"Position","slug":"position","actions":[],"properties":[{"name":"x","slug":"x","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"horizontal coordinate"},{"name":"y","slug":"y","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"vertical coordinate"}]},"Identity":{"name":"Identity","fqn":"Identity","slug":"identity","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Member ID of the group creator. See [Members API](https://dev.wix.com/api/rest/members/members/about-wix-members) for more details."},{"name":"identityType","slug":"identity-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"IdentityType","referenceFqn":"IdentityType"}}]},"IdentityType":{"name":"IdentityType","fqn":"IdentityType","slug":"identity-type","actions":[],"enumValues":["MEMBER","USER"],"properties":[]},"GroupDetails":{"name":"GroupDetails","fqn":"GroupDetails","slug":"group-details","actions":[],"properties":[{"name":"logo","slug":"logo","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Logo","referenceFqn":"Logo"},"description":"Group logo. You cannot upload your own logo."},{"name":"membersTitle","slug":"members-title","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"What group members are called, for example `Coworkers`, `Friends`, or `Students`."}]},"Logo":{"name":"Logo","fqn":"Logo","slug":"logo","actions":[],"properties":[{"name":"height","slug":"height","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Logo image height."},{"name":"mediaId","slug":"media-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Logo image ID (for internal use)."},{"name":"width","slug":"width","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Logo image width."}]},"GroupDetailsPosition":{"name":"GroupDetailsPosition","fqn":"GroupDetailsPosition","slug":"group-details-position","actions":[],"properties":[{"name":"x","slug":"x","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"horizontal coordinate"},{"name":"y","slug":"y","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"vertical coordinate"}]},"PrivacyStatus":{"name":"PrivacyStatus","fqn":"PrivacyStatus","slug":"privacy-status","actions":[],"enumValues":["PRIVATE","PUBLIC","SECRET","UNKNOWN"],"properties":[]},"GroupSettings":{"name":"GroupSettings","fqn":"GroupSettings","slug":"group-settings","actions":[],"properties":[{"name":"groupDetailsChangedPostEnabled","slug":"group-details-changed-post-enabled","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether an automatic post about changing the group details is enabled."},{"name":"membersCanApprove","slug":"members-can-approve","isDeprecated":true,"isInternal":false,"maturity":"GA","deprecation":{"message":"","replacedBy":"","targetRemovalDate":""},"type":{"kind":"PRIMITIVE","name":"boolean"},"description":"__Deprecated.__ Use `allowedToApproveJoinRequests` instead.\nWhether all group members are permitted to approve join group requests.\nIf `false`, member approval is limited to the admins."},{"name":"membersCanInvite","slug":"members-can-invite","isDeprecated":true,"isInternal":false,"maturity":"GA","deprecation":{"message":"","replacedBy":"","targetRemovalDate":""},"type":{"kind":"PRIMITIVE","name":"boolean"},"description":"__Deprecated.__ Use `allowedToInviteMembers` instead.\nWhether regular members are permitted to invite new members.\nIf `false`, only admins can invite members. Defaults to `true`."},{"name":"onboardingStepsSettings","slug":"onboarding-steps-settings","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"OnboardingStepSettings","referenceFqn":"OnboardingStepSettings"}}},{"name":"showMemberList","slug":"show-member-list","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether all members can see the full member list."},{"name":"welcomeMemberPostEnabled","slug":"welcome-member-post-enabled","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether a daily post about new members is enabled."}]},"AllowPolicy":{"name":"AllowPolicy","fqn":"AllowPolicy","slug":"allow-policy","actions":[],"enumValues":["ALL_MEMBERS","OWNER","OWNER_AND_ADMINS","UNKNOWN"],"properties":[]},"OnboardingStepSettings":{"name":"OnboardingStepSettings","fqn":"OnboardingStepSettings","slug":"onboarding-step-settings","actions":[],"properties":[{"name":"stepKey","slug":"step-key","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"StepKey","referenceFqn":"StepKey"}},{"name":"visible","slug":"visible","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"}}]},"StepKey":{"name":"StepKey","fqn":"StepKey","slug":"step-key","actions":[],"enumValues":["CREATE_POST","INVITE_MEMBERS","REACT_TO_POST","UNKNOWN"],"properties":[]},"CreateGroupOptions":{"name":"CreateGroupOptions","fqn":"CreateGroupOptions","slug":"create-group-options","actions":[],"properties":[{"name":"contentType","slug":"content-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ContentType","referenceFqn":"ContentType"},"description":"Content Type"},{"name":"creatorId","slug":"creator-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the member who created the group. This member will automatically become an admin."}]},"ContentType":{"name":"ContentType","fqn":"ContentType","slug":"content-type","actions":[],"enumValues":["DRAFTJS","PLAIN_TEXT","RICH_CONTENT"],"properties":[]},"DeleteGroupResponse":{"name":"DeleteGroupResponse","fqn":"DeleteGroupResponse","slug":"delete-group-response","actions":[],"properties":[{"name":"group","slug":"group","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Group","referenceFqn":"Group"},"description":"Deleted group."}]},"GetGroupOptions":{"name":"GetGroupOptions","fqn":"GetGroupOptions","slug":"get-group-options","actions":[],"properties":[{"name":"contentType","slug":"content-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ContentType","referenceFqn":"ContentType"},"description":"Content type (PLAIN_TEXT returns content as it is)"}]},"GetGroupBySlugResponse":{"name":"GetGroupBySlugResponse","fqn":"GetGroupBySlugResponse","slug":"get-group-by-slug-response","actions":[],"properties":[{"name":"group","slug":"group","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Group","referenceFqn":"Group"},"description":"Retrieved group."}]},"GetGroupBySlugOptions":{"name":"GetGroupBySlugOptions","fqn":"GetGroupBySlugOptions","slug":"get-group-by-slug-options","actions":[],"properties":[{"name":"autoInviteId","slug":"auto-invite-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}},{"name":"contentType","slug":"content-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ContentType","referenceFqn":"ContentType"},"description":"Content type (PLAIN_TEXT returns content as it is)"}]},"ListGroupIntegrationsDataResponse":{"name":"ListGroupIntegrationsDataResponse","fqn":"ListGroupIntegrationsDataResponse","slug":"list-group-integrations-data-response","actions":[],"properties":[{"name":"groupsIntegrationsData","slug":"groups-integrations-data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"GroupIntegrationsData","referenceFqn":"GroupIntegrationsData"}}}]},"GroupIntegrationsData":{"name":"GroupIntegrationsData","fqn":"GroupIntegrationsData","slug":"group-integrations-data","actions":[],"properties":[{"name":"connectedPricingPlanIds","slug":"connected-pricing-plan-ids","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}}},{"name":"eventIds","slug":"event-ids","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}}},{"name":"feedItemsCount","slug":"feed-items-count","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"}},{"name":"groupId","slug":"group-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}},{"name":"onlineProgramIds","slug":"online-program-ids","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}}},{"name":"topicIds","slug":"topic-ids","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}}}]},"ListGroupIntegrationsDataOptions":{"name":"ListGroupIntegrationsDataOptions","fqn":"ListGroupIntegrationsDataOptions","slug":"list-group-integrations-data-options","actions":[],"properties":[{"name":"groupIds","slug":"group-ids","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}}}]},"ListGroupsResponse":{"name":"ListGroupsResponse","fqn":"ListGroupsResponse","slug":"list-groups-response","actions":[],"properties":[{"name":"groups","slug":"groups","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Group","referenceFqn":"Group"}},"description":"Retrieved Groups."},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PagingMetadata","referenceFqn":"PagingMetadata"}}]},"PagingMetadata":{"name":"PagingMetadata","fqn":"PagingMetadata","slug":"paging-metadata","actions":[],"properties":[{"name":"count","slug":"count","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of items returned in the response."},{"name":"offset","slug":"offset","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Offset that was requested."},{"name":"tooManyToCount","slug":"too-many-to-count","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Flag that indicates the server failed to calculate the `total` field."},{"name":"total","slug":"total","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Total number of items that match the query."}]},"ListGroupsOptions":{"name":"ListGroupsOptions","fqn":"ListGroupsOptions","slug":"list-groups-options","actions":[],"properties":[{"name":"contentType","slug":"content-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ContentType","referenceFqn":"ContentType"},"description":"Content type (PLAIN_TEXT returns content as it is)"},{"name":"limit","slug":"limit","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of items to load. Maximum `100`."},{"name":"offset","slug":"offset","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of items to skip in the current sort order."}]},"ListGroupsByUserIdResponse":{"name":"ListGroupsByUserIdResponse","fqn":"ListGroupsByUserIdResponse","slug":"list-groups-by-user-id-response","actions":[],"properties":[{"name":"groups","slug":"groups","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"GroupWithMsId","referenceFqn":"GroupWithMsId"}}}]},"GroupWithMsId":{"name":"GroupWithMsId","fqn":"GroupWithMsId","slug":"group-with-ms-id","actions":[],"properties":[{"name":"groups","slug":"groups","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Group","referenceFqn":"Group"}}},{"name":"metaSiteId","slug":"meta-site-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}}]},"ListGroupsByUserIdOptions":{"name":"ListGroupsByUserIdOptions","fqn":"ListGroupsByUserIdOptions","slug":"list-groups-by-user-id-options","actions":[],"properties":[{"name":"contentType","slug":"content-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ContentType","referenceFqn":"ContentType"},"description":"Content type (PLAIN_TEXT returns content as it is)"}]},"GroupsQueryBuilder":{"name":"GroupsQueryBuilder","fqn":"GroupsQueryBuilder","slug":"groups-query-builder","actions":[{"name":"ascending","fqn":"GroupsQueryBuilder.ascending","slug":"ascending","isDeprecated":false,"isInternal":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"GroupsQueryBuilder","referenceFqn":"GroupsQueryBuilder"},"examples":[{"title":"Add an `ascending` sort to a query","content":"const query = groups.queryGroups.ascending('_createdDate');\n"},{"title":"Create a query, add an `ascending` sort, and run it","content":"import { groups } from 'wix-groups.v2';\n\nexport async function myQueryFunction() {\n const results = await groups.queryGroups().ascending('_createdDate').find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyNames","slug":"property-names","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"Properties used in the sort. To sort by multiple properties, pass properties as additional arguments."}],"description":"Adds a sort to a query, sorting by the specified properties in ascending order.\n\nThe `ascending()` function refines a `GroupsQueryBuilder` to sort by the value of `propertyName` in ascending order.\nYou can specify multiple properties for sorting in ascending order by passing each property name as an additional argument. `ascending()` sorts the results in the order the properties are passed.\nYou can sort the following types:\n- Number: Sorts numerically.\n- Date: Sorts by date and time.\n- String: Sorts lexicographically, so `'abc'` comes after `'XYZ'`.\nIf a property contains a number stored as a string (for example, `'0'`), that value is sorted alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest."},{"name":"descending","fqn":"GroupsQueryBuilder.descending","slug":"descending","isDeprecated":false,"isInternal":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"GroupsQueryBuilder","referenceFqn":"GroupsQueryBuilder"},"examples":[{"title":"Add a `descending` sort to a query","content":"const query = groups.queryGroups.descending('_createdDate');\n"},{"title":"Create a query, add a `descending` sort, and run it","content":"import { groups } from 'wix-groups.v2';\n\nexport async function myQueryFunction() {\n const results = await groups.queryGroups().descending('_createdDate').find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyNames","slug":"property-names","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"Properties used in the sort. To sort by multiple properties, pass properties as additional arguments."}],"description":"Adds a sort to a query, sorting by the specified properties in descending order.\n\nThe `descending()` function refines a `GroupsQueryBuilder` to sort by the value of `propertyName` in descending order.\nYou can specify multiple properties for sorting in descending order by passing each property name as an additional argument. `descending()` sorts the results in the order the properties are passed.\nYou can sort the following types:\n- Number: Sorts numerically.\n- Date: Sorts by date and time.\n- String: Sorts lexicographically, so `'abc'` comes after `'XYZ'`.\nIf a property contains a number stored as a string (for example, `'0'`), that value is sorted alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest."},{"name":"eq","fqn":"GroupsQueryBuilder.eq","slug":"eq","isDeprecated":false,"isInternal":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"GroupsQueryBuilder","referenceFqn":"GroupsQueryBuilder"},"examples":[{"title":"Add an `eq` filter to a query","content":"const query = groups.queryGroups.eq('title', 'some-title');\n"},{"title":"Create a query, add an `eq` filter, and run it","content":"import { groups } from 'wix-groups.v2';\n\nexport async function myQueryFunction() {\n const results = await groups\n .queryGroups()\n .eq('_id', 'bb19b637-74ce-55d3-ae32-430b588051da')\n .find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Property whose value is compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"any"},"description":"Value to compare against."}],"description":"Refines a query to match items where the specified property equals the specified value.\n\nThe `eq()` function refines a `GroupsQueryBuilder` to match only items where the value of the specified `propertyName` equals the specified `value`.\n`eq()` matches only values of the same type. For example, `0` stored as a number doesn't match `'0'` stored as a string.\nMatching strings with `eq()` is case-sensitive, so `'text'` isn't equal to `'Text'`."},{"name":"exists","fqn":"GroupsQueryBuilder.exists","slug":"exists","isDeprecated":false,"isInternal":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"GroupsQueryBuilder","referenceFqn":"GroupsQueryBuilder"},"examples":[{"title":"Add an `exists` filter to a query","content":"const query = groups.queryGroups.exists('description', 'some-description');\n"},{"title":"Create a query, add an `exists` filter, and run it","content":"import { groups } from 'wix-groups.v2';\n\nexport async function myQueryFunction() {\n const results = await groups\n .queryGroups()\n .exists('description', 'some-description')\n .find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"}}],"description":"Refines a query to match items where the specified property contains a value.\n\nThe `exists()` function refines a `GroupsQueryBuilder` to only match items where the value of the specified `propertyName` doesn't equal null or undefined.\n `exists()` checks for either existence or non-existence based on the boolen parameter. Note that `exists()` does match items where the value of the specified `propertyName` is an empty string or an invalid value. `exists()` is only useful for properties which don't contain default values and therefore their values may be unassigned."},{"name":"find","fqn":"GroupsQueryBuilder.find","slug":"find","isDeprecated":false,"isInternal":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"GroupsQueryResult","referenceFqn":"GroupsQueryResult"}},"examples":[{"title":"Run a query with no filters","content":"const query = groups.queryGroups.find();\n"},{"title":"Perform a `find` on a query","content":"import { groups } from 'wix-groups.v2';\n\nexport async function myQueryFunction() {\n const results = await groups.queryGroups().find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"description":"Returns the query results.\n\nThe `find()` function returns a Promise that resolves to the query results and metadata.\nThe Promise is rejected if `find()` is called with insufficient permissions or if any of the previous functions used to refine the query are invalid."},{"name":"hasSome","fqn":"GroupsQueryBuilder.hasSome","slug":"has-some","isDeprecated":false,"isInternal":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"GroupsQueryBuilder","referenceFqn":"GroupsQueryBuilder"},"examples":[{"title":"Add a `hasSome` filter to a query","content":"const query = groups.queryGroups.hasSome('labelIds', ['red', 'blue', 'purple']);\n"},{"title":"Create a query, add a `hasSome` filter, and run it","content":"import { groups } from 'wix-groups.v2';\n\nexport async function myQueryFunction() {\n const results = await groups\n .queryGroups()\n .hasSome('labelIds', ['red', 'blue', 'purple'])\n .find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Property whose value is compared with `values`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"any"}}}],"description":"Refines a query to match items whose specified property contains any of the specified values.\n\nThe `hasSome()` function refines a `GroupsQueryBuilder` to match only items where the value of the specified `propertyName` equals any of the specified `values`.\nMatching strings with `hasSome()` is case-sensitive, so `'text'` isn't equal to `'Text'`.\nIf the specified property is an array, `hasSome()` matches if any of that array's elements equal any of the specified values."},{"name":"in","fqn":"GroupsQueryBuilder.in","slug":"in","isDeprecated":false,"isInternal":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"GroupsQueryBuilder","referenceFqn":"GroupsQueryBuilder"},"examples":[{"title":"Add an `in` filter to a query","content":"const query = groups.queryGroups.in(\n ['labelIds', 'colors'],\n ['red', 'blue', 'purple']\n);\n"},{"title":"Create a query, add an `in` filter, and run it","content":"import { groups } from 'wix-groups.v2';\n\nexport async function myQueryFunction() {\n const results = await groups\n .queryGroups()\n .in(['labelIds', 'colors'], ['red', 'blue', 'purple'])\n .find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"any"}}],"description":"Refines a query to only match items where the specified property conatins any of the values in the provided array of values.\n\nThe `in()` function refines a `GroupsQueryBuilder` to match only items where the specified `propertyName` is equal to any of the values in the provided array.\nMatching strings with `in()` is case-sensitive, so `'text'` isn't equal to `'Text'`."},{"name":"limit","fqn":"GroupsQueryBuilder.limit","slug":"limit","isDeprecated":false,"isInternal":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"GroupsQueryBuilder","referenceFqn":"GroupsQueryBuilder"},"examples":[{"title":"Add a `limit` to a query","content":"const query = groups.queryGroups.limit(10);\n"},{"title":"Create a query, add a `limit`, and run it","content":"import { groups } from 'wix-groups.v2';\n\nexport async function myQueryFunction() {\n const results = await groups.queryGroups().limit(10).find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"limit","slug":"limit","isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Add a `limit` to a query","content":"const query = groups.queryGroups.limit(10);\n"},{"title":"Create a query, add a `limit`, and run it","content":"import { groups } from 'wix-groups.v2';\n\nexport async function myQueryFunction() {\n const results = await groups.queryGroups().limit(10).find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of items to return, which is also the `pageSize` of the results object."}],"description":"Limits the number of items the query returns.\n\nThe `limit()` function defines the number of results a query returns in each page. Only one page of results is retrieved at a time.\nYou can use the `next()` and `prev()` functions to navigate the pages of a query result."},{"name":"ne","fqn":"GroupsQueryBuilder.ne","slug":"ne","isDeprecated":false,"isInternal":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"GroupsQueryBuilder","referenceFqn":"GroupsQueryBuilder"},"examples":[{"title":"Add an `ne` filter to a query","content":"const query = groups.queryGroups.ne(\n '_id',\n 'bb19b637-74ce-55d3-ae32-430b588051da'\n);\n"},{"title":"Create a query, add an `ne` filter, and run it","content":"import { groups } from 'wix-groups.v2';\n\nexport async function myQueryFunction() {\n const results = await groups\n .queryGroups()\n .ne('_id', 'bb19b637-74ce-55d3-ae32-430b588051da')\n .find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Property whose value is compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"any"},"description":"Value to compare against."}],"description":"Refines a query to match items where the specified property doesn't equal the specified value.\n\nThe `ne()` function refines a `GroupsQueryBuilder` to match only items where the value of the specified `propertyName` doesn't equal the specified `value`.\n`ne()` matches only values of the same type. For example, `0` stored as a number doesn't match `'0'` stored as a string.\nMatching strings with `ne()` is case-sensitive, so `'text'` isn't equal to `'Text'`."},{"name":"skip","fqn":"GroupsQueryBuilder.skip","slug":"skip","isDeprecated":false,"isInternal":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"GroupsQueryBuilder","referenceFqn":"GroupsQueryBuilder"},"examples":[{"title":"Add a `skip` to a query","content":"const query = groups.queryGroups.skip(10);\n"},{"title":"Create a query, add a `skip`, and run it","content":"import { groups } from 'wix-groups.v2';\n\nexport async function myQueryFunction() {\n const results = await groups.queryGroups().skip(10).find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"skip","slug":"skip","isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Add a `skip` to a query","content":"const query = groups.queryGroups.skip(10);\n"},{"title":"Create a query, add a `skip`, and run it","content":"import { groups } from 'wix-groups.v2';\n\nexport async function myQueryFunction() {\n const results = await groups.queryGroups().skip(10).find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of items to skip in the query results before returning the results."}],"description":"Sets the number of items to skip before returning query results.\n\nThe `skip()` function defines the number of results to skip before returning new query results.\nFor example, if you query a collection and 50 items match your query, but you set `skip()` to `10`, the first 10 items that match are ignored, and the 11th through 50th items are returned."},{"name":"startsWith","fqn":"GroupsQueryBuilder.startsWith","slug":"starts-with","isDeprecated":false,"isInternal":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"GroupsQueryBuilder","referenceFqn":"GroupsQueryBuilder"},"examples":[{"title":"Add a `startsWith` filter to a query","content":"const query = groups.queryGroups.startsWith('title', 'L');\n"},{"title":"Create a query, add a `startsWith` filter, and run it","content":"import { groups } from 'wix-groups.v2';\n\nexport async function myQueryFunction() {\n const results = await groups.queryGroups();\n startsWith('title', 'L').find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Property whose value is compared with `string`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}}],"description":"Refines a query to match items where the specified property starts with the specified value.\n\nThe `startsWith()` function refines a `GroupsQueryBuilder` to match only items where the value of the specified `propertyName` starts with the specified `string`.\nMatching with `startsWith()` is case-sensitive, so `'TEXT'` doesn't start with `'text'`.\nYou can only use `startsWith()` with a property whose value is a string."}],"properties":[]},"GroupsQueryResult":{"name":"GroupsQueryResult","fqn":"GroupsQueryResult","slug":"groups-query-result","actions":[{"name":"hasNext","fqn":"GroupsQueryResult.hasNext","slug":"has-next","isDeprecated":false,"isInternal":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"boolean"},"examples":[{"title":"Get whether the query has more results","content":"const hasNext = results.hasNext();\n"},{"title":"Perform a query and get `hasNext` from the result","content":"import { groups } from 'wix-groups.v2';\n\nexport async function myQueryFunction() {\n const results = await groups.queryGroups().find();\n\n return results.hasNext();\n}\n"}],"description":"Indicates whether the query has more results.\n\nYou can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `groups` to navigate the pages of a query result."},{"name":"hasPrev","fqn":"GroupsQueryResult.hasPrev","slug":"has-prev","isDeprecated":false,"isInternal":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"boolean"},"examples":[{"title":"Get whether the query has previous results","content":"const hasPrev = results.hasPrev();\n"},{"title":"Perform a query and get `hasPrev` from the result","content":"import { groups } from 'wix-groups.v2';\n\nexport async function myQueryFunction() {\n const results = await groups.queryGroups().find();\n\n return results.hasPrev();\n}\n"}],"description":"Indicates whether the query has previous results.\n\nYou can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `groups` to navigate the pages of a query result."},{"name":"next","fqn":"GroupsQueryResult.next","slug":"next","isDeprecated":false,"isInternal":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"GroupsQueryResult","referenceFqn":"GroupsQueryResult"}},"examples":[{"title":"Get `next` from a query result","content":"const nextPage = results.next();\n"},{"title":"Perform a query and get `next` from the result","content":"import { groups } from 'wix-groups.v2';\n\nexport async function myQueryFunction() {\n const results = await groups.queryGroups().find();\n\n return results.next();\n}\n"},{"title":"Iterate through all pages of query results","content":"import { groups } from 'wix-groups.v2';\n\nexport async function myQueryFunction() {\n let allItems = [];\n\n const results = await groups.queryGroups().limit(1000).find();\n allItems.push(results.items);\n\n while (results.hasNext()) {\n results = await results.next();\n allItems.push(results.items);\n }\n\n return allItems;\n}\n"}],"description":"Retrieves the next page of query results.\n\nThe `next()` function retrieves the next page of query results.\nThe page size is defined by the [`limit()`](wix-groups-v2.Groups.GroupsQueryBuilder#limit) function and can be retrieved using the [`pageSize`](#pagesize) property. You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `groups` to navigate the pages of a query result.\nIf items are added or removed between calls to `next()`, the values returned by `GroupsQueryBuilder` may change."},{"name":"prev","fqn":"GroupsQueryResult.prev","slug":"prev","isDeprecated":false,"isInternal":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"GroupsQueryResult","referenceFqn":"GroupsQueryResult"}},"examples":[{"title":"Get `prev` from a query result","content":"const previousPage = results.prev();\n"},{"title":"Perform a query and get `prev` from the result","content":"import { groups } from 'wix-groups.v2';\n\nexport async function myQueryFunction() {\n const results = await groups.queryGroups().find();\n\n return results.prev();\n}\n"}],"description":"Retrieves the previous page of query results.\n\nThe `prev()` function retrieves the previous page of query results.\nThe page size is defined by the [`limit()`](wix-groups-v2.Groups.GroupsQueryBuilder#limit) function and can be retrieved using the [`pageSize`](#pagesize) property. You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `groups` to navigate the pages of a query result.\nIf items are added or removed between calls to `prev()`, the values returned may change."}],"properties":[{"name":"currentPage","slug":"current-page","isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get `currentPage` from a query result","content":"const resultPage = results.currentPage;\n"},{"title":"Perform a query and get `currentPage` from the result","content":"import { groups } from 'wix-groups.v2';\n\nexport async function myQueryFunction() {\n const results = await groups.queryGroups().find();\n\n return results.currentPage;\n}\n"}],"type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the index of the current page of results.\n\n`currentPage` is a zero-based index of the current page of results, meaning the 1st page is `0`, the 2nd page is `1`, and so on.\nIf no results match the query, `currentPage` is undefined.\nThe page size is defined by the [`limit()`](wix-groups-v2.Groups.GroupsQueryBuilder#limit) function and can be retrieved using the [`pageSize`](#pagesize) property. You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `groups` to navigate the pages of a query result."},{"name":"items","slug":"items","isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get `items` from a query result","content":"const returnedItems = results.items;\n"},{"title":"Perform a query and get `items` from the result","content":"import { groups } from 'wix-groups.v2';\n\nexport async function myQueryFunction() {\n const results = await groups.queryGroups().find();\n\n const returnedItems = results.items;\n\n if (returnedItems.length > 0) {\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Group","referenceFqn":"Group"}},"description":"Returns an array of `groups` items that match the query.\n\n`items` contains the current page of results retrieved by the query.\nIf no results match the query, `items` is an empty array.\nThe page size is defined by the [`limit()`](wix-groups-v2.Groups.GroupsQueryBuilder#limit) function and can be retrieved using the [`pageSize`](#pagesize) property. You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `groups` to navigate the pages of a query result."},{"name":"length","slug":"length","isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get `length` from a query result","content":"const resultLength = results.length;\n"},{"title":"Perform a query and get `length` from the result","content":"import { groups } from 'wix-groups.v2';\n\nexport async function myQueryFunction() {\n const results = await groups.queryGroups().find();\n\n return results.length;\n}\n"}],"type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the number of items in the current page of results.\n\n`length` returns just the number of items in the current page, not the total number of items that match the query. For the total number of items that match the query, see [`totalCount`](#totalcount).\nThe page size is defined by the [`limit()`](wix-groups-v2.Groups.GroupsQueryBuilder#limit) function and can be retrieved using the [`pageSize`](#pagesize) property. You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `groups` to navigate the pages of a query result."},{"name":"pageSize","slug":"page-size","isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get the query's page size","content":"const requestedPageSize = results.pageSize;\n"},{"title":"Perform a query and get `pageSize` from the result","content":"import { groups } from 'wix-groups.v2';\n\nexport async function myQueryFunction() {\n const results = await groups.queryGroups().find();\n\n return results.pageSize;\n}\n"}],"type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the requested page size.\n\n`pageSize` returns the page size set in [`limit()`](wix-groups-v2.Groups.GroupsQueryBuilder#limit) in `GroupsQueryBuilder`."},{"name":"query","slug":"query","isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get `query` that produced the current result","content":"const originalQuery = results.query;\n"},{"title":"Perform a query and get `query` from the result","content":"import { groups } from 'wix-groups.v2';\n\nexport async function myQueryFunction() {\n const results = await groups.queryGroups().find();\n\n return results.query;\n}\n"}],"type":{"kind":"REFERENCE","name":"GroupsQueryBuilder","referenceFqn":"GroupsQueryBuilder"},"description":"Returns the `GroupsQueryBuilder` object used to get the current results.\n\nUse `query` to create and run a new query by chaining additional `GroupsQueryBuilder` functions to it. You can filter only on properties that haven't already been used in the previous `GroupsQueryBuilder`."},{"name":"totalCount","slug":"total-count","isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get `totalCount` from a query result","content":"const resultCount = results.totalCount;\n"},{"title":"Perform a query and get `totalCount` from the result","content":"import { groups } from 'wix-groups.v2';\n\nexport async function myQueryFunction() {\n const results = await groups.queryGroups().find();\n\n return results.totalCount;\n}\n"}],"type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the total number of items that match the query.\n\n`totalCount` returns the total number of items that match the query, not just the number of items in the current page. For the number of items in the current page, see [`length`](#length)."},{"name":"totalPages","slug":"total-pages","isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get `totalPages` from a query result","content":"const pageCount = results.totalPages;\n"},{"title":"Perform a query and get `totalPages` from the result","content":"import { groups } from 'wix-groups.v2';\n\nexport async function myQueryFunction() {\n const results = await groups.queryGroups().find();\n\n return results.totalPages;\n}\n"}],"type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the total number of pages the query produced.\n\nThe page size is defined by the [`limit()`](wix-groups-v2.Groups.GroupsQueryBuilder#limit) function and can be retrieved using the [`pageSize`](#pagesize) property. You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `groups` to navigate the pages of a query result."}]},"QueryGroupsOptions":{"name":"QueryGroupsOptions","fqn":"QueryGroupsOptions","slug":"query-groups-options","actions":[],"properties":[{"name":"contentType","slug":"content-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ContentType","referenceFqn":"ContentType"},"description":"Content type (PLAIN_TEXT returns content as it is)"}]},"QueryGroupsByMembershipResponse":{"name":"QueryGroupsByMembershipResponse","fqn":"QueryGroupsByMembershipResponse","slug":"query-groups-by-membership-response","actions":[],"properties":[{"name":"groups","slug":"groups","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Group","referenceFqn":"Group"}},"description":"Retrieved groups."},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PagingMetadata","referenceFqn":"PagingMetadata"}}]},"QueryGroupsByMembershipOptions":{"name":"QueryGroupsByMembershipOptions","fqn":"QueryGroupsByMembershipOptions","slug":"query-groups-by-membership-options","actions":[],"properties":[{"name":"contentType","slug":"content-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ContentType","referenceFqn":"ContentType"},"description":"Content type (PLAIN_TEXT returns content as it is)"},{"name":"membershipStatus","slug":"membership-status","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MembershipStatus","referenceFqn":"MembershipStatus"}},{"name":"permissionsFilter","slug":"permissions-filter","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"GroupPermissions","referenceFqn":"GroupPermissions"},"description":"Filter groups by permissions."},{"name":"query","slug":"query","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Query","referenceFqn":"Query"}}]},"MembershipStatus":{"name":"MembershipStatus","fqn":"MembershipStatus","slug":"membership-status","actions":[],"enumValues":["JOINED","NONE","PENDING"],"properties":[]},"GroupPermissions":{"name":"GroupPermissions","fqn":"GroupPermissions","slug":"group-permissions","actions":[],"properties":[{"name":"canCreatePosts","slug":"can-create-posts","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"}}]},"Query":{"name":"Query","fqn":"Query","slug":"query","actions":[],"properties":[{"name":"fields","slug":"fields","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned."},{"name":"fieldsets","slug":"fieldsets","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned."},{"name":"filter","slug":"filter","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"any"},"description":"Filter object in the following format:\n`\"filter\" : {\n\"fieldName1\": \"value1\",\n\"fieldName2\":{\"$operator\":\"value2\"}\n}`\nExample of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`"},{"name":"paging","slug":"paging","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Paging","referenceFqn":"Paging"},"description":"Paging options to limit and skip the number of items."},{"name":"sort","slug":"sort","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Sorting","referenceFqn":"Sorting"}},"description":"Sort object in the following format:\n`[{\"fieldName\":\"sortField1\",\"order\":\"ASC\"},{\"fieldName\":\"sortField2\",\"order\":\"DESC\"}]`"}]},"Paging":{"name":"Paging","fqn":"Paging","slug":"paging","actions":[],"properties":[{"name":"limit","slug":"limit","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of items to load."},{"name":"offset","slug":"offset","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of items to skip in the current sort order."}]},"Sorting":{"name":"Sorting","fqn":"Sorting","slug":"sorting","actions":[],"properties":[{"name":"fieldName","slug":"field-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Name of the field to sort by."},{"name":"order","slug":"order","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"SortOrder","referenceFqn":"SortOrder"},"description":"Sort order."}]},"SortOrder":{"name":"SortOrder","fqn":"SortOrder","slug":"sort-order","actions":[],"enumValues":["ASC","DESC"],"properties":[]},"QueryJoinedGroupsResponse":{"name":"QueryJoinedGroupsResponse","fqn":"QueryJoinedGroupsResponse","slug":"query-joined-groups-response","actions":[],"properties":[{"name":"groups","slug":"groups","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Group","referenceFqn":"Group"}},"description":"Retrieved groups."},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PagingMetadata","referenceFqn":"PagingMetadata"}}]},"QueryJoinedGroupsOptions":{"name":"QueryJoinedGroupsOptions","fqn":"QueryJoinedGroupsOptions","slug":"query-joined-groups-options","actions":[],"properties":[{"name":"contentType","slug":"content-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ContentType","referenceFqn":"ContentType"},"description":"Content type (PLAIN_TEXT returns content as it is)"},{"name":"query","slug":"query","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Query","referenceFqn":"Query"}}]},"UpdateGroup":{"name":"UpdateGroup","fqn":"UpdateGroup","slug":"update-group","actions":[],"properties":[{"name":"_createdDate","slug":"created-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Group creation date and time."},{"name":"_id","slug":"id","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Group ID."},{"name":"_updatedDate","slug":"updated-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time of the latest group update."},{"name":"coverImage","slug":"cover-image","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CoverImage","referenceFqn":"CoverImage"},"description":"Cover image. You cannot upload your own cover image."},{"name":"description","slug":"description","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Group description in DraftJS format."},{"name":"lastActivityDate","slug":"last-activity-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time of the most recent group activity, for example a post or comment."},{"name":"memberTitle","slug":"member-title","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"What group members are called, for example `Coworkers`, `Friends`, or `Students`."},{"name":"membersCount","slug":"members-count","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Total count of current group members."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Group name."},{"name":"ownerId","slug":"owner-id","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Group owner."},{"name":"privacyStatus","slug":"privacy-status","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PrivacyStatus","referenceFqn":"PrivacyStatus"},"description":"Group privacy status.\n- `PUBLIC` - Anyone can see the group and its content. Anyone can join the group.\n- `PRIVATE` - Anyone can see the group, but only members can see its content. New member must submit a `Join Group Request`.\n- `SECRET` - Only admins and members can see the group. New members can only be added by other members."},{"name":"settings","slug":"settings","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"GroupSettings","referenceFqn":"GroupSettings"},"description":"Group specific settings. Available to the site owners under `Admin Tools` in the dashboard."},{"name":"slug","slug":"slug","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"A unique part of a group's URL, for example `https:/example.com/groups/slug`."},{"name":"teaser","slug":"teaser","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Group teaser."}]},"UpdateGroupOptions":{"name":"UpdateGroupOptions","fqn":"UpdateGroupOptions","slug":"update-group-options","actions":[],"properties":[{"name":"contentType","slug":"content-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ContentType","referenceFqn":"ContentType"},"description":"Content Type"}]}},"actions":[{"name":"createGroup","fqn":"createGroup","slug":"create-group","isDeprecated":false,"isInternal":false,"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["group"],"adminMethod":true,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"Group","referenceFqn":"Group"},"description":"Created group."},"examples":[{"title":"createGroup example for dashboard page code","content":"import { groups } from 'wix-groups.v2';\n\nasync function createGroup(group, options) {\n try {\n const result = await groups.createGroup(group, options);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n}\n"},{"title":"createGroup example for exporting from backend code","content":"import { groups } from 'wix-groups.v2';\nimport { webMethod, Permissions } from 'wix-web-module';\nimport { elevate } from 'wix-auth';\n\nconst elevatedCreateGroup = elevate(groups.createGroup);\n\nexport const createGroup = webMethod(\n Permissions.Anyone,\n async (group, options) => {\n try {\n const result = await elevatedCreateGroup(group, options);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n }\n);\n"}],"actionParams":[{"name":"group","slug":"group","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Group","referenceFqn":"Group"},"description":"Group to create."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CreateGroupOptions","referenceFqn":"CreateGroupOptions"},"description":"Optional fields for group creation."}],"description":"Creates a group.\n\n\nThe `createGroup()` function returns a Promise that resolves to a newly-created group after it has successfully been created. The new group is added to the Groups List page of your site.\n\nSite admins can choose to allow site members to create a group. They can also require that site members request their approval when creating a group. This setting can be found in your site's Dashboard under **Groups Application > General Settings > Group Creation**. If set to admin approval required, a site member uses this function to create a group, and the group becomes a `createRequest` with a status of `PENDING` until the group is reviewed. The default is set to site members with admin approval."},{"name":"deleteGroup","fqn":"deleteGroup","slug":"delete-group","isDeprecated":false,"isInternal":false,"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["groupId"],"adminMethod":true,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"DeleteGroupResponse","referenceFqn":"DeleteGroupResponse"}},"examples":[{"title":"deleteGroup example for dashboard page code","content":"import { groups } from 'wix-groups.v2';\n\nasync function deleteGroup(groupId) {\n try {\n const result = await groups.deleteGroup(groupId);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n}\n"},{"title":"deleteGroup example for exporting from backend code","content":"import { groups } from 'wix-groups.v2';\nimport { webMethod, Permissions } from 'wix-web-module';\nimport { elevate } from 'wix-auth';\n\nconst elevatedDeleteGroup = elevate(groups.deleteGroup);\n\nexport const deleteGroup = webMethod(\n Permissions.Anyone,\n async (groupId) => {\n try {\n const result = await elevatedDeleteGroup(groupId);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n }\n);\n"}],"actionParams":[{"name":"groupId","slug":"group-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the group to delete."}],"description":"Deletes a group.\n\n\nThe `deleteGroup()` function returns a Promise resolves to the deleted group after it has successfully been deleted. Only site admins and group admins can delete their group. After the group is deleted, it is removed from both your site and the site's Dashboard."},{"name":"getGroup","fqn":"getGroup","slug":"get-group","isDeprecated":false,"isInternal":false,"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["groupId"],"adminMethod":true,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"Group","referenceFqn":"Group"},"description":"Retrieved group."},"examples":[{"title":"getGroup example for dashboard page code","content":"import { groups } from 'wix-groups.v2';\n\nasync function getGroup(groupId, options) {\n try {\n const result = await groups.getGroup(groupId, options);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n}\n"},{"title":"getGroup example for exporting from backend code","content":"import { groups } from 'wix-groups.v2';\nimport { webMethod, Permissions } from 'wix-web-module';\nimport { elevate } from 'wix-auth';\n\nconst elevatedGetGroup = elevate(groups.getGroup);\n\nexport const getGroup = webMethod(\n Permissions.Anyone,\n async (groupId, options) => {\n try {\n const result = await elevatedGetGroup(groupId, options);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n }\n);\n"}],"actionParams":[{"name":"groupId","slug":"group-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the group to retrieve."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"GetGroupOptions","referenceFqn":"GetGroupOptions"}}],"description":"Gets a group by ID.\n\n\nThe `getGroup()` function returns a Promise that resolves to a group whose ID matches the given ID.\n\n> **Note:** For `SECRET` groups, only site admins, group admins, and group members can see a group and its content."},{"name":"getGroupBySlug","fqn":"getGroupBySlug","slug":"get-group-by-slug","isDeprecated":false,"isInternal":false,"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["slug"],"adminMethod":true,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"GetGroupBySlugResponse","referenceFqn":"GetGroupBySlugResponse"}},"examples":[{"title":"getGroupBySlug example for dashboard page code","content":"import { groups } from 'wix-groups.v2';\n\nasync function getGroupBySlug(slug, options) {\n try {\n const result = await groups.getGroupBySlug(slug, options);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n}\n"},{"title":"getGroupBySlug example for exporting from backend code","content":"import { groups } from 'wix-groups.v2';\nimport { webMethod, Permissions } from 'wix-web-module';\nimport { elevate } from 'wix-auth';\n\nconst elevatedGetGroupBySlug = elevate(groups.getGroupBySlug);\n\nexport const getGroupBySlug = webMethod(\n Permissions.Anyone,\n async (slug, options) => {\n try {\n const result = await elevatedGetGroupBySlug(slug, options);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n }\n);\n"}],"actionParams":[{"name":"slug","slug":"slug","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Unique part of the group's URL, for example `group-1` in `https:/example.com/groups/group-1`. Pass only the slug. Case-sensitive."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"GetGroupBySlugOptions","referenceFqn":"GetGroupBySlugOptions"}}],"description":"Gets a group by slug.\n\n\nThe `getGroupBySlug()` function returns a Promise that resolves to a group whose slug matches the given slug. The slug is the end of a group's URL that refers to a specific group. For example, if a group's URL is `https:/example.com/groups/{my-fitness-group}`, the slug is `my-fitness-group`. The slug is case-sensitive. It is generally based on the group name, but for secret groups it is an autogenerated string of characters, for example, `https:/example.com/groups/{5D3yTX}`.\n\n> **Note:** For `SECRET` groups, only site admins, group admins, and group members can see a group and its content."},{"name":"listGroups","fqn":"listGroups","slug":"list-groups","isDeprecated":false,"isInternal":false,"isDeveloperPreview":false,"maturity":"GA","adminMethod":true,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"ListGroupsResponse","referenceFqn":"ListGroupsResponse"}},"examples":[{"title":"listGroups example for dashboard page code","content":"import { groups } from 'wix-groups.v2';\n\nasync function listGroups(options) {\n try {\n const result = await groups.listGroups(options);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n}\n"},{"title":"listGroups example for exporting from backend code","content":"import { groups } from 'wix-groups.v2';\nimport { webMethod, Permissions } from 'wix-web-module';\nimport { elevate } from 'wix-auth';\n\nconst elevatedListGroups = elevate(groups.listGroups);\n\nexport const listGroups = webMethod(\n Permissions.Anyone,\n async (options) => {\n try {\n const result = await elevatedListGroups(options);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n }\n);\n"}],"actionParams":[{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ListGroupsOptions","referenceFqn":"ListGroupsOptions"},"description":"Limit and offset options."}],"description":"Lists groups.\n\n\nThe `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.\n\n> **Notes:**\n\n- For `SECRET` groups, only site admins, group admins, and group members can see a list of group and their content.\n- 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)`."},{"name":"queryGroups","fqn":"queryGroups","slug":"query-groups","isDeprecated":false,"isInternal":false,"isDeveloperPreview":false,"maturity":"GA","adminMethod":true,"returnType":{"kind":"REFERENCE","name":"GroupsQueryBuilder","referenceFqn":"GroupsQueryBuilder"},"examples":[{"title":"queryGroups example for dashboard page code","content":"import { groups } from 'wix-groups.v2';\n\nasync function queryGroups() {\n const { items } = groups.queryGroups().find();\n}\n"},{"title":"queryGroups example for exporting from backend code","content":"import { groups } from 'wix-groups.v2';\nimport { webMethod, Permissions } from 'wix-web-module';\nimport { elevate } from 'wix-auth';\n\nconst elevatedQueryGroups = elevate(groups.queryGroups);\n\nexport const queryGroups = webMethod(\n Permissions.Anyone,\n async (options) => {\n try {\n const result = await elevatedQueryGroups(options);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n }\n);\n"}],"actionParams":[{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"QueryGroupsOptions","referenceFqn":"QueryGroupsOptions"}}],"description":"Creates a query to retrieve a list of groups.\n\n\nNote: For `SECRET` groups, only site admins, group admins, and group members can query groups and their content. \n\nThe `queryGroups()` function builds a query to retrieve a list of all groups, and returns a GroupsQueryBuilder object.\n\n\n|PROPERTY\t|SUPPORTED FILTERS & SORTING\t\n|:---:|:---:|\n|`title`|[`eq()`](/groups/groups-query-builder/eq),[`ne()`](/groups/groups-query-builder/ne),[`exists()`](/groups/groups-query-builder/exists),[`in()`](/groups/groups-query-builder/in),[`hasSome()`](/groups/groups-query-builder/has-some),[`startsWith()`](/groups/groups-query-builder/starts-with),[`ascending()`](/groups/groups-query-builder/ascending),[`descending()`](/groups/groups-query-builder/descending)|\n|`membersCount`|[`ascending()`](/groups/groups-query-builder/ascending),[`descending()`](/groups/groups-query-builder/descending)|\n|`_createdDate`|[`ascending()`](/groups/groups-query-builder/ascending),[`descending()`](/groups/groups-query-builder/descending)|\n|`recentActivityDate`|[`ascending()`](/groups/groups-query-builder/ascending),[`descending()`](/groups/groups-query-builder/descending)|"},{"name":"updateGroup","fqn":"updateGroup","slug":"update-group","isDeprecated":false,"isInternal":false,"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["_id","group"],"adminMethod":true,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"Group","referenceFqn":"Group"},"description":"Updated group."},"examples":[{"title":"updateGroup example for dashboard page code","content":"import { groups } from 'wix-groups.v2';\n\nasync function updateGroup(id, group, options) {\n try {\n const result = await groups.updateGroup(id, group, options);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n}\n"},{"title":"updateGroup example for exporting from backend code","content":"import { groups } from 'wix-groups.v2';\nimport { webMethod, Permissions } from 'wix-web-module';\nimport { elevate } from 'wix-auth';\n\nconst elevatedUpdateGroup = elevate(groups.updateGroup);\n\nexport const updateGroup = webMethod(\n Permissions.Anyone,\n async (id, group, options) => {\n try {\n const result = await elevatedUpdateGroup(id, group, options);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n }\n);\n"}],"actionParams":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Group ID."},{"name":"group","slug":"group","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"UpdateGroup","referenceFqn":"UpdateGroup"}},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"UpdateGroupOptions","referenceFqn":"UpdateGroupOptions"}}],"description":"Updates a group.\n\n\nThe `updateGroup()` function returns a Promise that resolves to the updated group. Only site admins and group admins can update their group. Only the fields in the groupInfo object parameter can be updated. Specify which fields to update. Unspecified fields remain the same.\n\n> **Notes:**\n\n- When a group's `privacyStatus` is updated from `PRIVATE` to `PUBLIC`, all pending join requests for that group are automatically approved.\n- When a group's `privacyStatus` is updated from `PRIVATE` to `SECRET`, all pending join requests for that group are automatically rejected.\n- When a public or private group's name is updated, the slug is updated to reflect the new group name."}],"webhooks":[],"articles":[{"content":"---\ntitle: Introduction\n---\n# Introduction\n\n \n\n

\n Developer Preview\n
\n APIs in Developer Preview are subject to change and are not intended for use in production.
Send us your suggestions for improving this API. Your feedback is valuable to us.\n

\n\n \n\n> __Note__: This module is [universal](/api-overview/api-versions#universal-modules). Functions in this module can run on both the backend and frontend, unless specified otherwise.\n\nThe Groups API provides functionality for managing groups, including creating, deleting, updating, and querying groups.\n\n## Settings for Typical Use Case\nSite admins determine who can create a group. This setting can be found in your site's Dashboard under **Groups Application > General Settings > Group Creation**.\nIf set to site members with admin approval, site members can create a group using the `createGroup()` function, and the group becomes a `createRequest` with a name of `PENDING`. The site admin either approves or rejects the request to create a group.\nIf set to all site members, site members can create a group using the `createGroup()` function (no approval required).\nIf set to only admins, only site admins can create a group using the `createGroup()` function.\nThe default is set to site members with admin approval.\n\nWhen a group is created, the newly created group is added to the Groups List page of your site.\n\nThe Groups API provides functionality allowing you to:\n* Create a new group.\n* Delete an existing group.\n* Get group information by ID.\n* Get group information by slug.\n* List all groups.\n* Query groups.\n* Update group information.\n\n### Permissions Information\n>**Note:** You can override the permissions below by using the `wix-auth` [`elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function.\n\n| Functions | Permissions \n| --- | --- |\n| `createGroup()` | Manage in your site's Dashboard. **Note:** If you override this permission with the `elevate()` function, you must provide a creatorId when running the function.\n| `deleteGroup()`, `updateGroup()` | Site admin, group admin.\n| `listGroups()`, `getGroup()`, `queryGroups()` | For public & private groups: any site member. For secret groups: group members, site admin.\n\n

\n
Warning: Elevating a function allows it to be called by any site visitor. Exercise caution to prevent security vulnerabilities.
\n

\n\nTo use the Groups API,\nimport `groups` from wix-groups.v2:\n\n```js\nimport { groups } from 'wix-groups.v2';\n```\n\n","displayName":"Introduction","slugifyName":"introduction"}],"builderTypes":[{"kind":"REFERENCE","name":"GroupsQueryBuilder","referenceFqn":"GroupsQueryBuilder"},{"kind":"REFERENCE","name":"GroupsQueryResult","referenceFqn":"GroupsQueryResult"}],"properties":[],"namespaces":[]}},"reviewStatus":"UNKNOWN","isLocked":false,"metadata":{"packageVersion":"1.0.55"}}