Filter a Response Body

Resource

All

HTTP method

GET

Request parameters

exclude, include, and filterGroup

Use the exclude and include query parameters to filter a response body when making a request. The query value is a bar (|) delimited list of properties. URL encode the bar as %7C. Use a forward slash (/) before each property name.

Use the filterGroup query parameter to specify whether to return a Big, Medium, or Small response body. Every property in every response body is assigned one of these group sizes.

Request parameter example

This News Feed URL resource:

1/chatter/users/me?include=/aboutMe%7C/address

For a detailed list of rules and examples, see Specifying Response Sizes.

Returns

A filtered response body

The request parameter example above returns this for the Feed response body:

1{
2   "aboutMe": "Salesforce Administrator and Citizen Developer",
3   "address": {
4      "city": "San Francisco",
5      "country": "US",
6      "formattedAddress": "1 Market St\nSan Francisco, CA 94105\nUS",
7      "state": "CA",
8      "street": "1 Market St",
9      "zip": "94105"
10   }
11}

Chatter REST API Developer Guide

Filter a Response Body