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

List of Groups

A list of all the groups in the organization. Get information about groups or create a group.
Resource
1/chatter/groups/
Available version
23.0
POST available in 29.0
Requires Chatter
Yes
HTTP methods
GET, HEAD, POST
Request parameters for GET
Parameter Name Type Description Available
archiveStatus String Returns the list of groups filtered by the archive status you specify:
  • All—All groups, including groups that are archived and groups that are not archived.
  • Archived—Only groups that are archived.
  • NotArchived—Only groups that are not archived.

The default value is NotArchived.

 29.0
page Integer An integer specifying a page of items. The default value is 0, which returns the first page. 23.0
pageSize Integer Specifies the number of items per page. Valid values are between 1 and 250. The default value is 25. 23.0
q String Specifies the string to search. The search string must contain at least two characters, not including any wildcards. For more information about wildcards, see Wildcards. 23.0
Request body for POST
Root XML Tag
1<group>
JSON
1{
2   "announcement" : "0D5D0000000K4XT",
3   "canHaveChatterGuests" : "true",
4   "description" : "This group is building a powerful API.",
5   "information" : {
6      "text" : "Read this section before you post to the group.",
7      "title" : "Information"
8   },
9   "isArchived" : "false",
10   "isAutoArchiveDisabled" : "false",
11   "name" : "Chatter API",
12   "owner" : "00590000000DmPw",
13   "visibility" : "PublicAccess"
14}
Properties
Name Type Description Available Version
announcement String An announcement ID.

An announcement displays in a designated location in the Salesforce UI until 11:59 p.m. on its expiration date, unless it’s deleted or replaced by another announcement.

 31.0
canHaveChatterGuests Boolean true if this group allows Chatter customers, false otherwise. After this property is set to true, it cannot be set to false. 29.0
description String The “Description” section of the group 29.0
information Group Information Input The “Information” section of the groupIn the Web UI, the “Information” section is above the “Description” section. If the group is private, the “Information” section is visible only to members. The “Description” section is visible to everyone. 28.0
isArchived Boolean true if the group is archived, false otherwise. Defaults to false. 29.0
isAutoArchiveDisabled Boolean true if automatic archiving is turned off for the group, false otherwise. Defaults to false. 29.0
name String The name of the group 29.0
owner String The ID of the group owner. This property is available for PATCH requests only. 29.0
visibility String Specifies the group visibility type. One of the following values:
  • PrivateAccess—Only members of the group can see posts to this group.
  • PublicAccess—All users within the community can see posts to this group.
  • Unlisted—Reserved for future use.
29.0
Request parameters for POST
Parameter Name Type Description Required or Optional Available
canHaveChatterGuests Boolean true if this group allows Chatter customers, false otherwise. After this property is set to true, it cannot be set to false. Optional 29.0
description String The “Description” section of the group Optional 29.0
informationText String The text in the “Information” section of the group Optional 29.0
informationTitle String The title of the “Information” section of the group Optional 29.0
name String The name of the group Required 29.0
visibility String Specifies the group visibility type. One of the following:
  • PrivateAccess—Only members of the group can see posts to this group.
  • PublicAccess—All users within the community can see posts to this group.
  • Unlisted—Reserved for future use.
Required 29.0
Response body for GET
Group Page
Response body for POST
Group Detail
Example for POST
This request creates a public group:
1POST /chatter/groups?name=New+Group&visibility=PublicAccess