Chatter REST API Developer Guide
jSummer '26 (API version 67.0)
Spring '26 (API version 66.0)
Winter '26 (API version 65.0)
Summer '25 (API version 64.0)
Spring '25 (API version 63.0)
Winter '25 (API version 62.0)
Summer '24 (API version 61.0)
Spring '24 (API version 60.0)
Winter '24 (API version 59.0)
Summer '23 (API version 58.0)
Spring '23 (API version 57.0)
Winter '23 (API version 56.0)
Summer '22 (API version 55.0)
Spring '22 (API version 54.0)
Winter '22 (API version 53.0)
Summer '21 (API version 52.0)
Spring '21 (API version 51.0)
Winter '21 (API version 50.0)
Summer '20 (API version 49.0)
Spring '20 (API version 48.0)
Winter '20 (API version 47.0)
Summer '19 (API version 46.0)
Spring '19 (API version 45.0)
Winter '19 (API version 44.0)
Summer '18 (API version 43.0)
Spring '18 (API version 42.0)
Winter '18 (API version 41.0)
Summer '17 (API version 40.0)
Spring '17 (API version 39.0)
Winter '17 (API version 38.0)
Summer '16 (API version 37.0)
Spring '16 (API version 36.0)
Winter '16 (API version 35.0)
Summer '15 (API version 34.0)
Spring '15 (API version 33.0)
Winter '15 (API version 32.0)
Spring '14 (API version 30.0)
When to Use Chatter REST API
Chatter REST API Architecture
Chatter 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
Response Body Encoding
Status Codes and Error Responses
Use CORS to Access Salesforce Resources from Web Browsers
Newer Version Available
Chatter REST API Introduction
Consider the Chatter REST API architecture, rate limits, and how the resources,
requests, and responses work.
-
When to Use Chatter REST API
Is Chatter REST API the right API for you? -
Chatter REST API Architecture
To use Chatter REST API, understand a few characteristics of its architecture, like how to authenticate, and which data formats it supports. -
Chatter REST API Rate Limits
Chatter REST API requests are subject to rate limiting. Chatter REST API has a different rate limit than other Salesforce APIs. Chatter REST API has a per user, per application, per hour rate limit. When you exceed the rate limit, all Chatter REST API resources return a 503 Service Unavailable error code. -
Build the Resource URL
Access all Chatter REST API resources by using the URI for your company's instance, combined with version and community information, and the URI for the resource. -
Send HTTP Requests
Chatter 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 Chatter 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 Chatter REST API and Chatter 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 Chatter REST API
Chatter REST API uses OAuth to securely identify your application before connecting to Salesforce. -
Use CORS to Access Salesforce Resources from Web Browsers
Cross-Origin Resource Sharing (CORS) enables web browsers to request resources from origins other than their own (cross-origin). For example, using CORS, JavaScript code at https://www.example.com could request a resource from https://www.salesforce.com. To access supported Salesforce APIs, Apex REST resources, and Lightning Out from JavaScript code in a web browser, add the origin serving the code to a Salesforce CORS whitelist.