Get custom report
get_report[Reports] Get a custom report's JSON definition, visibility, your access and its version. Read it before update_report: the definition is replaced whole and the version must match.
The report's JSON definition, visibility, your access (owner, edit, view) and its version (needed to update it). People who can edit also get the unpublished draft, if any.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Report id (from list_reports). | |
| merchant_id | No | Optional merchant to scope to. Admins and sub-merchant operators only; other callers always use their token's merchant. | |
| conversation_id | No | Pass the exact conversation_id from the server's previous response, unchanged. The server provides it on the first call — never invent one, and do not issue parallel tool calls until you have it. Keep passing the same conversation_id for the rest of the conversation, including after later user messages or on a different task; do not reset it when the user starts a new request. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ||
| title | Yes | ||
| access | Yes | ||
| version | Yes | ||
| admin_url | Yes | ||
| definition | No | The published ReportDefinition. | |
| visibility | Yes | ||
| draft_definition | No | Unpublished edits (only for people who can edit), or null. | |
| _mcp_instructions | No | Server-issued metadata for this conversation. |