Connect REST API Developer Guide

Connect REST API Developer Guide
Introduction
When to Use Connect REST API
Connect REST API Architecture
Connect REST API Rate Limits
Build the Resource URL
Send HTTP Requests
HTTP Request Flow and a Response Body
Inputs and Binary File Upload Examples
Wildcards
Specify Response Sizes
Response Body Encoding
Status Codes and Error Responses
OAuth and Connect REST API
Use CORS to Access Salesforce Resources from Web Browsers
Quick Start
Work with Features
Examples
Resources
Request Bodies
Response Bodies
Appendices
PDF

Newer Version Available

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

Build the Resource URL

Access all Connect REST API resources by using the URI for your company's instance, combined with version and community information, and the URI for the resource.
For example, building a URL without communities, your instance is:
1https://instance_name
And the version information is: 
1/services/data/v49.0
And the resource is:
1/chatter/feeds/news/me/feed-elements
Put together, the full URL is:
1https://instance_name/services/data/v49.0/chatter/
2feeds/news/me/feed-elements
To access resources that are part of a community, use this path after the version information and before the resource:
1/connect/communities/communityId
For example, the following full URL accesses a news feed resource in a community:
1https://instance_name/services/data/v49.0/connect
2/communities/communityId/chatter/feeds/news/me/feed-elements
To access resources in the default community, use the internal shortcut as the community ID:
1/connect/communities/internal

You can use the internal shortcut even if communities are not enabled. For example, if you’re developing an application for multiple organizations, not all of which use communities, you can use this shortcut.

The response bodies include URLs with /connect/communities/internal. This format enables you to perform string interpolation when referencing communities.

To access resources in the default community, you can also use the /chatter resources directly (without /connect/communities/internal). The response bodies don’t include URLs with /connect/communities/internal.

In addition, you can also use your organization’s custom URL for a community to access resources in it. For example:
1https://communitydomain.force.com/communitypath/services/data/v49.0/connect
2/communities/communityId/chatter/feeds/news/me/feed-elements

To query resources from your Salesforce org where Communities has same-named objects, such as Groups, you must make the call from your Salesforce instance name or you will have community specific resources returned.

Note