Group Object


Properties
idstringRead-onlyformat GUID

Group ID.


slugstringminLength 1maxLength 100

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


privacyLevelstringdeprecated

Deprecated. Use privacyStatus instead. This property will be removed on June 30, 2022.


privacyStatusstring

Group privacy status.

  • PUBLIC - Anyone can see the group and its content. Anyone can join the group.
  • PRIVATE - Anyone can see the group, but only members can see its content. New member must submit a Join Group Request.
  • SECRET - Only admins and members can see the group. New members can only be added by other members.

titlestringdeprecatedmaxLength 100

Deprecated. Use name instead. This property will be removed on June 30, 2022.


namestringmaxLength 100

Group name.


descriptionstringmaxLength 20480

Group description in DraftJS format.


teaserstringmaxLength 1000

Group teaser.


detailsDetailsdeprecated

Deprecated. For details.logo, use coverImage instead. For details.membersTitle, memberTitle instead. This property will be removed on June 30, 2022.


memberTitlestringminLength 1maxLength 1000

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


coverImageCoverImage

Cover image. You cannot upload your own cover image.


settingsSettings

Group specific settings. Available to the site owners under Admin Tools in the dashboard.


membersCountintegerRead-onlyformat int32

Total count of current group members.


createdByCreatedByRead-onlydeprecated

Deprecated. Use ownerId instead. This property will be removed on June 30, 2022.


ownerIdstringRead-only

Group owner.


createdDatestringRead-onlyformat date-time

Group creation date and time.


updatedDatestringRead-onlyformat date-time

Date and time of the latest group update.


recentActivityDatestringRead-onlydeprecatedformat date-time

Deprecated. Use lastActivityDate instead. This property will be removed on June 30, 2022.


lastActivityDatestringRead-onlyformat date-time

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

Did this help?