Including Objects
Many objects contain the ID of a related object in their response properties. For example, an Order
may have an associated Message
ID. Those objects can be included inline with the includes
request parameter. Objects that can be included are noted in this documentation. This parameter is available on all API requests, and applies to the response of that request only.
You can nest include requests with the dot property. For example, requesting message.form_submission
on an order will include the message
property creating a full Message
object, and will then include the form_submission
property on that message creating a full Form Submission
object.
You can include multiple objects at once by identifying multiple items in the includes
comma separated string.