Additional behaviors with read inclusion

Using query parameters with included resources

Some endpoints support the ability to query for a given type of resource and for related resource types. For example, the default behavior of the GET /activities endpoint is to return only activity resources. However, you can use the include query parameter to include any notes related to the returned activities in the response payload. These types of resources are referred to as included resources. The technique of adding included resources to a GET is sometimes referred to as response inclusion or read inclusion. For more information on how to construct a GET with included resources, see Payload structure for a response with included resources.

You can also use query parameters with included resources. For example, the following call GETs all activities assigned to the current user and includes any related notes. The number of notes returned is limited to 5.

GET /activities?include=notes&pageSize=notes:5

For more information on how to use query parameters with included resources, see Query parameters for included resources.