getGroupBySlug( )


Retrieves a group by 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. Slugs are 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}.

For groups with group.privacyStatus set to SECRET, only group admins and group members can see the group and its content.

Method Declaration
Copy
Method Parameters
slugstringRequired

Unique part of the group's URL. For example, if a group's URL is https:/example.com/groups/{my-fitness-group}, the slug is my-fitness-group. Case-sensitive.


optionsGetGroupBySlugOptions
Returns
Return Type:Promise<GetGroupBySlugResponse>
Errors

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

Did this help?