Section: Best practices

Return a request ID

http
http
X-Request-Id: req_01HXYZ123
Explanation

A request identifier lets support teams correlate API failures with logs and traces quickly.

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 Best practices
Keep response contracts consistent
Use the same top-level response structure across endpoints.
OpenIn sheettextsame section
Use ISO 8601 timestamps
Prefer explicit timezone-aware datetime strings.
OpenIn sheettextsame section
Document rate limits clearly
Help clients back off safely.
OpenIn sheethttpsame section
Provide copy-paste examples
Show real requests and responses in docs.
OpenIn sheetbashsame section
Verbs in CRUD endpoints
Avoid route names that duplicate the HTTP method.
OpenIn sheettext1 tag match
Do not return 200 for every outcome
Use HTTP status codes meaningfully.
OpenIn sheettext1 tag match