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.
  • 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.