Connect REST API Developer Guide

Connect REST API Developer Guide
Introduction
When to Use Connect REST API
Connect REST API Architecture
Connect REST API 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
Perform Cross-Origin Requests 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 Experience Cloud site information, and the URI for the resource.
For example, building a URL without Experience Cloud sites, your instance is:
And the version information is:
And the resource is:
Put together, the full URL is:
To access resources that are part of an Experience Cloud site, use this path after the version information and before the resource:
For example, the following full URL accesses a news feed resource in a site:
To access resources in the default Experience Cloud site, use the internal shortcut as the site ID:

You can use the internal shortcut even if digital experiences isn’t enabled. For example, if you’re developing an application for multiple orgs, not all of which use Experience Cloud sites, you can use this shortcut.

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

To access resources in the default Experience Cloud site, 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 use your org’s URL for an Experience Cloud site to access resources in it. For example:

If you’re not using enhanced domains, your org’s Experience Cloud sites URL is different. For details, see My Domain URL Formats in Salesforce Help.

Note

To query resources from your Salesforce org where Experience Cloud sites have same-named objects, such as Groups, you must make the call from your Experience Cloud site My Domain name or site-specific resources are returned.

Note