REST API Resource Naming and URL Design/Use includes for related resources

Let clients opt into embedded relationships.

Section: Path vs query parameters

Use includes for related resources

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

Optional includes can reduce round trips while keeping the base response lightweight.

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 Path vs query parameters
Put resource identity in the path
Use the path for the primary resource being addressed.
OpenIn sheethttpsame section
Use query parameters for filtering
Filter a collection with query fields.
OpenIn sheethttpsame section
Use query parameters for field selection
Return only needed fields.
OpenIn sheethttpsame section
Use consistent casing in paths
Pick one URL style and use it consistently.
OpenIn sheettext1 tag match
Avoid format suffixes in paths
Negotiate format via headers, not path suffixes.
OpenIn sheettext1 tag match
Name relationships clearly
Make related collections obvious.
OpenIn sheettext1 tag match