Connect REST API Introduction | Connect REST API Developer Guide

When to Use Connect REST API
Is Connect REST API the right API for you?

Connect REST API Architecture
To use Connect REST API, understand a few characteristics of its architecture, like how to authenticate, and which data formats it supports.

Connect REST API Limits
Most Connect REST API requests are subject to the same rate limits as other Salesforce APIs. Only requests to Chatter REST API resources (a subset of Connect REST API resources) are subject to a per user, per application, per hour rate limit. When you exceed the rate limit, Connect REST API resources return a 503 Service Unavailable error code.

Build the Resource URL
Access 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.

Send HTTP Requests
Connect REST API uses HTTP methods to send and receive JSON and XML content, so it’s easy to build client applications using the tool or the language of your choice.

HTTP Request Flow and a Response Body
Review the process flow for Connect REST API, including resource and response examples.

Inputs and Binary File Upload Examples
Make HTTP POST, PATCH, and PUT requests using inputs and learn more about uploading binary files.

Wildcards
Use wildcard characters to match text patterns in Connect REST API and Connect in Apex searches.

Specify Response Sizes
Use filter parameters to return only the data the application needs. To specify the response size by group (big, medium, or small), use filterGroup as a request parameter or in a request body. In addition, to exclude or include specific properties, use either exclude or include as a request parameter or in a request body.

Response Body Encoding
Responses are minimally HTML entity-encoded by default.

Status Codes and Error Responses
The response header contains an HTTP status code. If the response isn’t successful, the response body contains an error message, and if appropriate, information about the field or object where the error occurred.

OAuth and Connect REST API
Connect REST API uses OAuth to securely identify your application before connecting to Salesforce.

Connect REST API Release Notes
Use the Salesforce Release Notes to learn about the most recent updates and changes to Connect REST API.

API End-of-Life Policy
Salesforce is committed to supporting each API version for a minimum of three years from the date of first release. In order to mature and improve the quality and performance of the API, versions that are more than three years old sometimes are no longer supported.