Chatter REST API Developer's Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Group

Property Type Description Filter Group and Version Available Version
additional​Label 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
canHave​ChatterGuests 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
emailTo​ChatterAddress 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
isAutoArchive​Disabled Boolean Specifies whether automatic archiving is disabled for the group (true) or not (false). Big, 29.0 29.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
lastFeedItem​PostDate String Date of the most recent feed item posted to the group Big, 29.0 24.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:
  • GroupOwner
  • GroupManager
  • NotAMember
  • NotAMemberPrivateRequested
  • StandardMember
 Small, 29.0 23.0
mySubscription Reference If the logged-in 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
recordViewUrl String The URL of the Chatter REST API record view resource for this record, or null if this record does not have a record view layout, or if “Connect Records API” is not enabled for this organization, or if the record type isn’t supported. Small, 30.0 30.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:
  • PrivateAccess
  • PublicAccess
 Small, 29.0 23.0