Chatter REST API Developer Guide
jNewer Version Available
Group
| Property | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| additionalLabel | String | An additional label for the group, for example, “Archived,” “Private,” or “Private With Customers.” If there isn’t an additional label, the value is null. | Small, 30.0 | 30.0 |
| announcement | Announcement | An announcement for the group. | Big, 31.0 | 31.0 |
| bannerPhoto | Banner Photo | The banner photo for the group. | Big, 36.0 | 36.0 |
| canHaveChatterGuests | Boolean | true if this group allows Chatter customers, false otherwise | Small, 29.0 | 23.0 |
| community | Reference | Information about the community. Returns null if group exists in the default community or communities aren’t enabled. | Medium, 29.0 | 26.0 |
| description | String | Text-only description of the group | Big, 29.0 | 23.0 |
| emailToChatterAddress | String | Group’s email address for posting to
this group by email. Returns null if Chatter emails and posting to Chatter by email aren’t both enabled in your organization. |
Medium, 30.0 | 30.0 |
| isArchived | Boolean | Specifies whether the group is archived (true) or not (false). | Big, 29.0 | 29.0 |
| isAutoArchiveDisabled | Boolean | Specifies whether automatic archiving is disabled for the group (true) or not (false). | Big, 29.0 | 29.0 |
| isBroadcast | Boolean | Specifies whether the group is a broadcast group (true) or not (false). In a broadcast group, only group owners and managers can post to the group. | Big, 36.0 | 36.0 |
| fileCount | Integer | Number of files posted to this group | Big, 29.0 | 24.0–27.0 The fileCount property is in the Group Detail response body. |
| id | String | 18-character ID of the group | Small, 29.0 | 23.0 |
| isArchived | Boolean | Specifies whether the group is archived (true) or not (false). | Big, 29.0 | 29.0 |
| isAutoArchiveDisabled | Boolean | Specifies whether automatic archiving is disabled for the group (true) or not (false). | Big, 29.0 | 29.0 |
| lastFeedElementPostDate | Date | Date of the most recent feed element posted to the group | Big, 31.0 | 31.0 |
| lastFeedItemPostDate | Date | Date of the most recent feed item posted to the group. After API version 30.0, use lastFeedElementPostDate. |
Big, 29.0 | 24.0–30.0 |
| memberCount | Integer | Total number of group members | Small, 29.0 | 23.0 |
| motif | Motif | Small, medium, and large icons indicating that the object is a group. The motif
can also contain the record type’s base color. The icon is not the group photo. |
Small, 29.0 | 27.0 |
| myRole | String | Values are:
|
Small, 29.0 | 23.0 |
| mySubscription | Reference | If the context user is a member of this group, this contains information about that subscription, or returns null otherwise | Medium, 29.0 | 23.0 |
| name | String | Name of the group | Small, 29.0 | 23.0 |
| owner | User Summary | Information about the owner of the group | Medium, 29.0 | 24.0 |
| photo | Photo | Information about the group photo | Small, 29.0 | 23.0 |
| type | String | CollaborationGroup | Small, 29.0 | 23.0 |
| url | String | Relative URL string to the group | Small, 29.0 | 23.0 |
| visibility | String | Values are:
|
Small, 29.0 | 23.0 |