REST API Request and Response Patterns/Embed related resources on demand

Include relationships when the client asks for them.

Section: Response shaping

Embed related resources on demand

http
http
GET /orders/ord_123?include=customer,items
Explanation

Optional includes preserve a lightweight base contract while allowing richer reads.

Learn the surrounding workflow

Compare similar commands or jump into common fixes when this command is part of a bigger troubleshooting path.

Related commands

Same sheet · prioritizing Response shaping
Sparse fieldsets
Return only requested fields.
OpenIn sheethttpsame section
Return an ETag for concurrency and caching
Tag a representation with a revision validator.
OpenIn sheethttpsame section
Protect updates with If-Match
Prevent lost updates from concurrent writes.
OpenIn sheethttpsame section
Represent async work as a job resource
Queue work and let clients poll job state.
OpenIn sheetjsonsame section
Simple create request body
POST a resource representation.
OpenIn sheetjson1 tag match
Partial update body
PATCH with only the fields that change.
OpenIn sheetjson1 tag match