Chatter REST API Developer Guide
jNewer Version Available
Communities
You can request most Chatter REST API resources within a specific community. For example, you can make requests to feeds, files, groups, topics, and users resources within a specific community. If a resource is available in communities, its documentation includes a resource that starts with /connect/communities/communityId.
Some Chatter REST API resources are available only within a community. These include resources for flagging and moderating content, using managed topics, and getting information about a user’s reputation.
Resources that are available in communities are available whether you allow access without logging in or not. However, if your community allows access without logging in, guest users don’t have access to any Chatter REST API resources.
The resources that are available only within a community are listed in this table.
| Resource | HTTP Methods | Tasks | |
|---|---|---|---|
| /connect/communities | GET | Get a list of all communities available to the context user. Create a community. | |
| /connect/communities/communityId | GET | Get information about a community. | |
| /connect/communities/communityId/publish | POST | Publish a community. | |
| /connect/communities/communityId/chatter/comments/commentId/moderation-flags | GET, POST, DELETE | If the context user is a community moderator, get the number of times community members flagged a comment. Also
flag a comment for moderation and delete all flags on a comment. If the context user isn’t a community moderator, returns whether the user flagged a comment. Also flag a comment for moderation and remove a flag the user previously added. |
|
| /connect/communities/communityId/chatter/feed-elements/feedElementId/capabilities/moderation | GET, POST, DELETE | Get information about a feed element's moderation capability, add a moderation flag to a feed element, or delete all moderation flags from a feed element. | |
| /connect/communities/communityId/files/moderation | GET |
If the context user is a community moderator, get the files that community members flagged. |
|
| /connect/communities/communityId/files/fileId/moderation-flags | GET, POST, DELETE | If the context user is a community moderator, get the number of times community members flagged a file. Also
flag a file for moderation and delete all flags on a file. If the context user isn’t a community moderator, get whether the user flagged a file. Also flag a file for moderation and remove a flag the user previously added. |
|
| /connect/communities/communityId/chatter/feeds/moderation/feed-elements | GET | If the context user is a community moderator with the Moderate Communities Feeds permission, returns a list of all feed elements and comments in the community that have been flagged by community members. By default, returns 25 feed elements per page of results. | |
| /connect/communities/communityId/chatter/feeds/home/feed-elements | GET | The feed containing feed elements and comments from the community home. | |
| /connect/communities/communityId/managed-content/delivery | GET | Get published managed content versions for a community. | |
| /connect/communities/communityId/managed-topics | GET, POST, PATCH | Get all the managed topics for a community. Create a managed topic, create managed topic hierarchies, and reorder managed topics. | |
| /connect/communities/communityId/managed-topics/managedTopicId | GET, DELETE | Get information about or delete a managed topic in a community. | |
| /connect/communities/communityId/missions/users/userId | PATCH | Update the mission activity count for a user. | |
| /connect/communities/communityId/missions/users/userId/activities/export-job | GET | Export mission activity for a user. | |
| /connect/communities/communityId/missions/users/userId/activities/purge-job | POST | Start a job to purge mission activity for the user. | |
| /connect/communities/communityId/navigation-menu/navigation-menu-items | GET | Get navigation menu items for a community. | |
| /connect/communities/communityId/personalization/audiences | GET, POST | Get a list of audiences that include the context user. Create an audience. | |
| /connect/communities/communityId/personalization/audiences/audienceId | GET, PATCH, DELETE | Get, update, and delete an audience. | |
| /connect/communities/communityId/personalization/targets | GET, POST, PATCH | Get a list of targets that match the context user, based on the audiences that include the user. Create and update targets. | |
| /connect/communities/communityId/personalization/targets/batch/targetIds | GET | Get target information for a comma-separated list of target IDs. | |
| /connect/communities/communityId/personalization/targets/targetId | GET, DELETE | Get or delete a target. | |
| /connect/communities/communityId/question-and-answers/top-unanswered (pilot) | GET | Get the top unanswered questions for the context user in a community. | |
| /connect/communities/communityId/topics/topicId/trending-articles | GET | Get trending articles for a topic in a community. | |
| /connect/communities/communityId/trending-articles | GET | Get trending articles for a community. | |
| /connect/communities/communityId/chatter/users/userId/audit-actions/counts | GET | Get audit statistics for a user in a community. | |
| /connect/communities/communityId/chatter/users/userId/reputation | GET | Returns the specified community user's reputation. |