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

To Feed Resources

A feed containing all @mentions of the context user and posts others have made to the context user's feed.

Available resources are:

Resource Description
/chatter/feeds/to/me Returns a URL to the feed elements for the feed of the context user.
/chatter/feeds/to/me/feed-elements Returns the feed elements for all @mentions of the context user, and all posts made to the user's feed.

To Feed URL

Returns a URL to the feed elements for the feed of the context user.

Resource
1/chatter/feeds/to/me
OR
1/chatter/feeds/to/userId

userId must be the ID of the context user or the alias me.

Note

Available since version
23.0
Requires Chatter
Yes
HTTP methods
GET, HEAD
Request parameters
Parameter Name Type Description
sort String Specifies the order returned by the sort, such as by date created or last modified:
  • CreatedDateDesc—Sorts by most recent creation date.
  • LastModifiedDateDesc—Sorts by most recent activity.
The default value is CreatedDescDate.
Response body
Feed

To Feed Elements

Returns the feed elements for all @mentions of the context user, and all posts made to the user's feed. The To Feed includes posts that mention you and posts that other users make to your wall. Your own posts are included only if they have a comment. The comment can be from you or from another user.

Resource
1/chatter/feeds/to/me/feed-elements
OR
1/chatter/feeds/to/userId/feed-elements

userId must be the ID of the context user or the alias me.

Note

Available since version
31.0
Requires Chatter
Yes
HTTP methods
GET, HEAD
Request parameters
Parameter Name Type Description Required or Optional Available Version
density String The density of the feed. One of these values:
  • AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of.
  • FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of, but hides some system-generated updates from records.

The default value is AllUpdates.

 Optional 31.0
elementsPerBundle Integer Maximum number of feed elements to include in a bundle. The value must be an integer between 0 and 10. The default value is 3.

Bundled posts are available through a pilot program. For information, contact Salesforce. During the pilot, bundles contain only feed-tracked changes.

Note

 Optional 31.0
page String A generated token that indicates the view of feed elements in the feed.Page tokens are returned as part of the response body, in one of the URL parameters, such as nextPageURL, for example: 
1"nextPageUrl": 
2"/services/data/v32.0/
3chatter/feeds/news/
4005D0000001GLowIAN
5/feed-elements
6?page=2011-03-30T17:34:50Z,
70D5D0000000DSv4KAG"
 Optional 31.0
pageSize Integer The number of feed elements per page. Valid values are between 1 and 100. The default size is 25. Optional 31.0
q String One or more keywords to search for in the body and comments of feed elements in this feed.

The search string can contain wildcards and must contain at least two characters that aren’t wildcards. See Wildcards.

 Optional 31.0
recentComment​Count Integer Maximum number of comments to include per feed element. The default value is 3. The maximum value is 25. Optional 31.0
sort String Specifies the order returned by the sort, such as by date created or last modified:
  • CreatedDateDesc—Sorts by most recent creation date.
  • LastModifiedDateDesc—Sorts by most recent activity.
The default value is CreatedDescDate.		 Optional 31.0
Response body for GET
Feed Element Page

To Feed Items

Returns the feed items for all @mentions of the context user, and all posts made to the user's feed. The To Feed includes posts that mention you and posts that other users make to your wall. Your own posts are included only if they have a comment. The comment can be from you or from another user.

Resource
1/chatter/feeds/to/me/feed-items
OR
1/chatter/feeds/to/userId/feed-items

userId must be the ID of the context user or the alias me.

Note

Available versions
23.0–31.0

In version 32.0 and later, use To Feed Elements.

Important

Requires Chatter
Yes
HTTP methods
GET, HEAD
Request parameters
Parameter Name Type Description Required or Optional Available Version
density String The density of the feed. One of these values:
  • AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of.
  • FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of, but hides some system-generated updates from records.

The default value is AllUpdates.

 Optional 29.0–31.0
page String A generated token that indicates the view of feed items in the feed. Page tokens are returned as part of the response body, in one of the URL parameters, such as nextPageURL, for example: 
1"nextPageUrl": 
2"/services/data/v32.0/
3chatter/feeds/news/
4005D0000001GLowIAN
5/feed-items
6?page=2011-03-30T17:34:50Z,
70D5D0000000DSv4KAG"
 Optional 23.0–31.0
pageSize Integer Specifies the number of items per page. Valid values are between 1 and 100. If you don't specify a size, the default is 25. Optional 23.0–31.0
q String One or more keywords to search for in the body and comments of feed items in this feed.

The search string can contain wildcards and must contain at least two characters that aren’t wildcards. See Wildcards.

 Optional 28.0–31.0
recentComment​Count Integer Maximum number of comments to include per feed item. The default value is 3. The maximum value is 25. Optional 29.0–31.0
sort String Specifies the order returned by the sort, such as by date created or last modified:
  • CreatedDateDesc—Sorts by most recent creation date.
  • LastModifiedDateDesc—Sorts by most recent activity.
The default value is CreatedDescDate.		 Optional 23.0–31.0
Response body for GET
Feed Item Page

To Feed Items Flat

This resource is deprecated as of version 26.0.

Returns a flat feed, that is, a feed where there is no hierarchy between feed items and comments: Feed items and comments are at the same level. All items are returned in chronological order.

Resource
1/chatter/feeds/to/me/feed-items/flat
or
1/chatter/feeds/to/userId/feed-items/flat

userId must be the ID of the context user or the alias me.

Note

Available since version
25.0–26.0
Requires Chatter
Yes
HTTP methods
GET or HEAD
Request parameters
Parameter Name Type Description
numFeedItems Integer Specifies the number of feed items returned. Valid values are between 0 and 100. Default value is 25. Because feed items may include comments, specifying 25 flat feed items may actually return more. For example, if each feed item has one comment, and recentCommentCount is greater than 1, 50 flat feed items are returned.
page String A generated token that indicates the view of feed items in the feed. Page tokens are returned as part of the response body, in one of the URL parameters, such as nextPageURL.
recentComment​Count Integer Specifies the number of recent comments returned. Valid values are between 0 and 25. Default value is 3.
sort String. One of the following:
  • CreatedDateDesc
  • LastModifiedDateDesc
 Sorts the returned feed either by created date in ascending order, or by last modified date, also in ascending order. The default is LastModifiedDateDesc
Response body
Flat Feed