include

To limit the response body to specific properties, use the include query string parameter.

The value for the include query string parameter is a list of properties separated by bars (|). You must URL encode the bars as %7C. Include a forward slash before every property name.

The following request includes only the aboutMe property and the address property in a response body:

The following rules describe how to use the include query parameter.

Include a forward slash (/) before property names or the request returns an error.

Original output:

Include value: include=bar

Filtered output: 400 error with error code INVALID_FILTER_VALUE.

Original output:

Include value: include=/bar

Filtered output:

Top-level properties are ignored. Note there is no error when you try this.

Original output:

Include value: include=/foo

Filtered output:

Use a bar (|) delimiter to filter multiple properties. URL encode the delimiter as %7C.

Original output:

Include value: include=/foo%7C/bar

Filtered output:

Original output:

Include value: include=/someObject

Filtered output:

To filter a property nested in a response body, include the parent response body name as a filter segment.

Original output:

Include value: include=/someObject/sub

Filtered output:

Identify an item in a list by its property name. This example uses XML.

Original output:

Include value: include=/someList/item/id

Filtered output:

Identify an item in a list by its property name. This example uses JSON.

Original output:

Include value: include=/someList/item/id

Filtered output: