read

Where in the Magistry dashboard the merchant goes to act on something, and what they press when they get there. Returns

Changed on Oct 20, 2026

Where in the Magistry dashboard the merchant goes to act on something, and what they press when they get there. Returns the page name as it appears in the menu, its URL, the section heading on that page and the exact button text — scoped to THIS tenant, so a surface this business does not have is never suggested. CALL THIS BEFORE TELLING A MERCHANT TO DO ANYTHING IN MAGISTRY. Reading a proposal, an alert or a customer thread tells you WHAT is waiting; only this tells you WHERE it is. Pass question in plain language ("where do I approve a proposal", "how do I answer a customer") to get the ranked answers, or omit it for the whole map.

post/api/v1/tools/where_in_magistry

Request

Base URL: https://app.magistry.io
URL: https://app.magistry.io/api/v1/tools/where_in_magistry
Auth: one of:
- HTTP bearer
- OAuth 2 (authorization code, authorization URL https://app.magistry.io/api/oauth/authorize, token URL https://app.magistry.io/api/oauth/token, scopes: read)

Request body

questionstring

What the merchant wants to do, in plain language. Omit to list every destination.

Response

Tool result

okboolean required

resultunknown required

Changes

Oct 20, 20264a749f94b35c Revision changes
- warning
  added the new app_not_reviewed enum value to the response property for the response status
- warning
  added the new app_not_reviewed enum value to the response property for the response status
- warning
  added the new app_not_reviewed enum value to the response property for the response status
- warning
  added the new app_not_reviewed enum value to the response property for the response status
- warning
  added the new app_not_reviewed enum value to the response property for the response status
- warning
  added the new app_not_reviewed enum value to the response property for the response status
- warning
  added the new app_not_reviewed enum value to the response property for the response status
- warning
  added the new app_not_reviewed enum value to the response property for the response status
- warning
  added the new app_not_reviewed enum value to the response property for the response status
- warning
  added the new app_not_reviewed enum value to the response property for the response status
- warning
  added the new app_not_reviewed enum value to the response property for the response status
- warning
  added the new unsupported_behavior enum value to the response property for the response status
- warning
  added the new unsupported_behavior enum value to the response property for the response status
- warning
  added the new unsupported_behavior enum value to the response property for the response status
- warning
  added the new unsupported_behavior enum value to the response property for the response status
- warning
  added the new unsupported_behavior enum value to the response property for the response status
- warning
  added the new unsupported_behavior enum value to the response property for the response status
- warning
  added the new unsupported_behavior enum value to the response property for the response status
- warning
  added the new unsupported_behavior enum value to the response property for the response status
- warning
  added the new unsupported_behavior enum value to the response property for the response status
- warning
  added the new unsupported_behavior enum value to the response property for the response status
- warning
  added the new unsupported_behavior enum value to the response property for the response status

Operation history