Chatter REST API Developer Guide

Introducing Chatter REST API
Chatter REST API Quick Start
Chatter REST API Features
Chatter REST API Examples
Chatter REST API Resources
Action Links Resources
Announcements Resources
Async Query Resources
Clean Resources
Batch Resource
Chatter Resources
Comments Resources
Communities Resources
Communities Knowledge Resources
Communities Moderation Resources
Connect Resources
Dashboard Component Snapshot Resource
Datacloud Resources
Environment Hub Resources
External Email Services Resource
Feed Elements Resources
Feed Items Resources
Feeds Resources
Bookmarks Feed Resources
Communities Home Feed Resource
Communities Moderation Feed Resources
Company Feed Resources
Favorites Feed Resources
Feeds Resource
Files Feed Resources
Filter Feed Resources
Groups Feed Resources
Mute Feed Resources
News Feed Resources
People Feed Resources
Record Feed Resource
To Feed Resources
Topics Feed Resources
User Profile Feed Resources
Files Connect Repository Resources
Files Resources
Folders Resources
Forecasts Resources
Groups Resources
Influence Resource
Likes Resource
Managed Topics Resources
Mentions Resources
Motifs Resources
Push Notifications Resource
Question and Answers Suggestions Resource
Recommendation Audience Resources
Recommendation Definition Resources
Records Resources
Scheduled Recommendations Resources
Subscriptions Resource
Topics Resources
User Profiles Resources
Users Resources
Zones Resources
Chatter REST API Request Bodies
Chatter REST API Response Bodies
Chatter REST API Appendices
PDF

Newer Version Available

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

Files Feed Resources

A feed containing all the feed elements that contain files posted by people or groups that the context user follows.

Available resources are:

Resource Description
/chatter/feeds/files/me Returns the URL to the feed elements that contain files that are posted by users or groups the context user is following.
/chatter/feeds/files/me/feed-elements Returns all feed elements posted with files by people or groups that the context user follows.

Files Feed URL

Returns the URL to the feed elements that contain files that are posted by users or groups the context user is following.

Resource
1/chatter/feeds/files/userId
1/connect/communities/communityId/chatter/feeds/files/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 or HEAD
Request parameter
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

Files Feed Elements

Returns all feed elements posted with files by people or groups that the context user follows.

Resource
1/chatter/feeds/files/userId/feed-elements
1/connect/communities/communityId/chatter/feeds/files/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 from 0 through 10. The default value is 3. 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: 
1"nextPageUrl": 
2"/services/data/v37.0/
3chatter/feeds/news/
4005D0000001GLowIAN
5/feed-elements
6?page=2011-03-30T17:34:50Z,
70D5D0000000DSv4KAG"
 Optional 31.0
pageSize Integer Specifies the number of elements per page. Valid values are from 1 through 100. If you don't specify a size, the default 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
updatedSince String An opaque token defining the modification time stamp of the feed and the sort order.

Do not construct this token. Retrieve this token from the updatesToken property of the Feed Element Page response body.

The updatedSince parameter doesn’t return feed elements that are created in the same second as the request.

 Optional 31.0
Response body
Feed Element Page

Files Feed Items

Returns all feed items posted with files by people or groups that the context user follows.

Resource
1/chatter/feeds/files/me/feed-items
or
1/chatter/feeds/files/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 Files 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 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/v37.0/
3chatter/feeds/news/
4005D0000001GLowIAN
5/feed-elements
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 elements 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
updatedSince String An opaque token defining the modification time stamp of the feed and the sort order.

Do not construct this token. Retrieve this token from the updatesToken property of the Feed Element Page response body.

 Optional 30.0–31.0
Response body
Feed Item Page

Files 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/files/me/feed-items/flat
or
1/chatter/feeds/files/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 from 0 through 100. Default value is 25. Because feed items can 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 from 0 through 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