> For the complete documentation index, see [llms.txt](https://help.mimeeq.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.mimeeq.com/developers/response-shape.md).

# Response shape

Every successful response carries its payload under `data` — a single resource, or an array on list endpoints. Anything describing the request rather than the resource sits beside it at the root, today just `page` on lists. Reading a field off the root that is not `data` means reading metadata, so new root fields can never collide with a field of the resource.

Writes on collection sets, galleries, global option sets, product categories and product groups return the resource as it now stands, read back after the write — so you do not need a follow-up request, and what you get is what the backend actually stored, which is not always what you sent. The remaining resources still answer with an identifier.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://help.mimeeq.com/developers/response-shape.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
