Skip to main content

​
Overview

Use the include query parameter when you need related data alongside the resources you request. This lets you get that data in the same response and keep responses smaller when you do not need it. Each endpoint’s API reference lists the relationships it supports and the fields they add. Includes are only available on endpoints that document the include parameter.

​
Supported routes

​
Query format

Pass include once, using a comma-separated list of supported relationship names. Whitespace around names is ignored; repeating a name does not duplicate the included data. Unsupported names, empty values, and repeated include query parameters return 400. Use only the names listed in the endpoint’s reference.

​
Response behavior

Includes add related data to each returned resource. They do not change which resources match your request. When you omit include, you get the endpoint’s default response. The endpoint’s response schema describes the included fields and what to expect when related data is unavailable.

​
Pagination

Follow the response’s next URL to keep includes on subsequent pages. See Pagination for the response format.