Newer Version Available

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

Working with Salesforce Files

Use Chatter REST API to work with Salesforce Files, which includes Salesforce Files Sync.

Use Salesforce Files to upload, store, find, follow, share, and collaborate on files in the cloud.

Use Salesforce Files Sync to securely store, sync, and share files between Chatter, the desktop, and mobile devices. Access files and folders from anywhere, and keep them instantly updated across your organization.

Resource HTTP Methods Tasks
/chatter/feed-elements GET, POST Post feed elements and search all feed elements in an organization.
/chatter/feeds/files/me/feed-elements GET Returns all feed elements posted with files by people or groups that the context user follows.
/chatter/feeds/news/me/feed-elements GET All feed elements from all groups the context user either owns or is a member of, as well as all files, records, and users the context user follows. Use this resource to get information about feed elements and to post feed elements.
/chatter/feeds/records/​recordId/feed-elements GET Returns the feed elements for all the records the context user is following, or all the feed elements of the specified recordId. Use this resource to search a feed or to get the feed elements for a specific feed. To use this resource to get the feed elements for a group, specify the group ID as the recordId.
/chatter/feeds/user-profile/​userId/feed-elements GET Returns the feed elements for all actions on all records that can be tracked in a feed.
/chatter/files/fileId GET, POST, PATCH, DELETE Get information about a specified file, including references to external files. Upload a new version of an existing file, including references to external files. Rename a file, move a file to a different folder, and delete a file.
/chatter/files/fileId/content GET Returns the content of the file, including references to external files. The content is streamed as the body of the response.
/chatter/files/fileId/file-shares GET, POST Returns information about the objects with which the specified file has been shared. Objects can be users, groups, or records. Can also be used to share the specified file with users.
/chatter/files/fileId/file-shares/link GET, PUT, DELETE A description of a file shared as a link. Create, access, and delete a file’s share link.
/chatter/files/fileId/rendition GET A rendition of the file. A rendition is a binary preview of the file. The format of the binary depends on the format specified in the request.
/chatter/files/batch/fileIds GET, DELETE Information about a list of files, specified by file IDs. Get information about a list of files and delete a list of files.
/chatter/folders/folderId GET, PATCH, DELETE Get information about the specified folder. Move, rename, and delete a folder. Sync the root folder.
/chatter/folders/folderId/items GET, POST Get information about the contents of a folder. Add a file to a folder and create a folder. Sync the root folder.
/chatter/groups/groupId/files GET Returns information about the files posted to the specified group.
/connect/topics/topicId/files GET Returns information about the five files most recently posted to the specified topic.
/chatter/users/userId/files GET, POST Post a file, including references to external files, to Salesforce Files Sync or get information about files a user owns. These files don’t include files shared with a user, files a user follows, or general organization files.
/chatter/users/me/files/filter/groups GET Returns information about files posted to groups that the specified user is a member of.
/chatter/users/me/files/filter/shared-with-me GET Returns information about files that have been shared with the specified user.

You can replace the alias me with the user ID of the context user.

Note