Connect REST API Developer Guide
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)
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
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
filterGroup
exclude
include
Response Body Encoding
Status Codes and Error Responses
Perform Cross-Origin Requests from Web Browsers
Connect REST API Release Notes
API End-of-Life Policy
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.
To exclude or include properties, use a path to select a node. To find the path, make a request to the resource and ask for an XML response instead of JSON. The XML includes node names and JSON doesn’t. To request an XML response, append .xml to the resource, for example /services/data/v44.0/chatter/feeds/record/a07B00000079vKZIAY/feed-elements.xml. Copy the XML into a file and open it in a browser or an IDE that generates an XML tree. Identify the path to the node you want to include or exclude and use it in your request: /services/data/v44.0/chatter/feeds/record/a07B00000079vKZIAY/feed-elements.xml?exclude=/elements/feedElement/actor.
Important
-
filterGroup
Use the filterGroup parameter in a request URL or in a request body to specify whether to return a small, medium, or big group of properties. The filterGroup property is available in API version 29.0 and later. -
exclude
To exclude specific properties from a response body, use the exclude request parameter. The exclude parameter is available in API version 27.0 and later. -
include
To limit the response body to specific properties, use the include query string parameter.