> For the complete documentation index, see [llms.txt](https://docs.shipbubble.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.shipbubble.com/get-started/request-and-responses.md).

# Request and Responses

JSON is used to format both the request body and the returned data (response). Application/JSON will always be the content type for responses. In general, all responses will be formatted as follows:

<table><thead><tr><th width="182">Field</th><th>Datatype</th><th>Description</th></tr></thead><tbody><tr><td>status</td><td><em>String</em></td><td>Helps differentiate responses, it either returns '<strong>success</strong>' or '<strong>failed</strong>'</td></tr><tr><td>message</td><td><em>String</em></td><td>Gives a description of the status returned (do not use for your checks)</td></tr><tr><td>data</td><td><em>Object</em></td><td>Contains actionable result of a successfully processed request if present</td></tr><tr><td>errors</td><td><em>Array</em></td><td>Contains errors pertaining to a request body (e.g invalid parameter submitted)</td></tr></tbody></table>