Query parameters for included resources
Some endpoints support the ability to query for a given type of resource and for resource
types related to that type. For example, by default, the GET /activities
endpoint returns 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.
The syntax for adding included resources is:
For example, GET /activities?include=notes returns all activities assigned
to the current caller, and all notes associated with those activities.
For more information on the default behavior of include, see Payload structure for a response with included resources.
Most query parameters that can be used on primary resources can also be used on included resources.