Group Object


A group object represents a community space where site members can connect and share content. You can create groups and manage their visibility, settings, and metadata. Learn more about groups.

Properties
coverImageCoverImage

Cover image. You cannot upload your own cover image.


createdDatestringRead-onlyformat date-time

Group creation date and time.


descriptionstringmaxLength 20480

Group description in DraftJS format.


idstringRead-onlyformat GUID

Group ID.


lastActivityDatestringRead-onlyformat date-time

Date and time of the most recent group activity, for example a post or comment.


membersCountintegerRead-onlyformat int32

Total count of current group members.


memberTitlestringminLength 1maxLength 1000

What group members are called, for example Coworkers, Friends, or Students.


namestringmaxLength 100

Group name.


ownerIdstringRead-onlyformat GUID

Group owner.


privacyStatusstring

Group privacy status.


settingsGroupSettings

Group specific settings.

These settings can also be found in a site's Dashboard.


slugstringminLength 1maxLength 100

A unique part of a group's URL, for example https:/example.com/groups/slug.


teaserstringmaxLength 1000

Group teaser.


updatedDatestringRead-onlyformat date-time

Date and time of the latest group update.

Did this help?