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.

The filterGroup parameter is supported for JSON only and for REST only.

Note

Every property in every response body is assigned a group size:

Big—The default size. Includes every property in a response body, including those marked Big, Medium, and Small.
Medium—Includes properties marked Medium and Small.
Small—The smallest response size. Includes only properties marked Small.

The size assignments are visible only in the documentation. They aren’t visible in the response bodies.

Note

When a request includes a filterGroup, the response body only includes properties that are part of the specified group.

Things to know about using filter groups:

The default filterGroup size is Big.
Each filter group size assigned to a property has an API version. In future API versions properties may move to different filter groups.
Filter groups affect all HTTP verbs except DELETE and HEAD.
You can use a filterGroup parameter on any request URL, including subrequests in a batch request body, unless otherwise stated.
You can use a filterGroup parameter in conjunction with either an include or an exclude filter parameter to change the set of properties returned. The resulting set is a union of the two sets.

Using a filterGroup parameter with an include or exclude parameter

Requests can contain a filterGroup parameter and group size value, and either an include or an exclude filter parameter and value on the URL. This is also true for subrequests in a generic batch request.

When a request (or a subrequest) contains both a filterGroup parameter and an include parameter, the response always includes the properties specified by the include parameter.

When a request (or a subrequest) contains both a filterGroup parameter and an exclude parameter, the response always excludes the properties specified by the exclude parameter.

In this table, read a row from left to right to see whether the property is included in the response.

`include` Filter Provided in Request	Property Provided in `include` Filter in Request	`exclude` Filter Provided in Request	Property Provided in `exclude` Filter in Request	`filterGroup` Provided in Request	Property Provided in `filterGroup` in Request	Property Included In Response
Yes	No	No	No	No	No	No
Yes	Yes	No	No	Yes or No	Yes or No	Yes
No	No	Yes	No	No	No	Yes
No	No	Yes	No	Yes	No	No
No	No	Yes	Yes	Yes or No	Yes or No	No
No	No	No	No	Yes	No	No
No	No	No	No	Yes	Yes	Yes
Yes	Yes or No	Yes	Yes or No	Yes or No	Yes or No	Error (400)

Example

This example gets the Small response body for the User Profile resource:

1GET /chatter/users/me?filterGroup=Small

This is the response:

1{
2   "companyName": "Universal Containers",
3   "firstName": "Deanna",
4   "hasChatter": true,
5   "id": "005D0000001LL8OIAW",
6   "isActive": true,
7   "isInThisCommunity": true,
8   "lastName": "Li",
9   "motif": {
10      "color": "1797C0",
11      "largeIconUrl": "/img/icon/profile64.png",
12      "mediumIconUrl": "/img/icon/profile32.png",
13      "smallIconUrl": "/img/icon/profile16.png"
14   },
15   "name": "Deanna Li",
16   "photo": {
17      "photoVersionId": "729D00000000LJFIA2",
18      "smallPhotoUrl": "https://instance_name/profilephoto/729D00000000LJF/T",
19      "standardEmailPhotoUrl": "https://instance_name/ncsphoto
20       /SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5sYVo6fntPnCQ_-xIH-GU3vI",
21      "url": "/services/data/v32.0/chatter/users/005D0000001LL8OIAW/photo"
22   },
23   "title": null,
24   "type": "User",
25   "url": "/services/data/v32.0/chatter/users/005D0000001LL8OIAW",
26   "username": "dli@uc.com"
27}

Chatter REST API Developer's Guide

No Results

filterGroup

Using a filterGroup parameter with an include or exclude parameter

Example