read

Search and list products in the current store. Supports filtering by lifecycle_state (e.g. "active", "draft", "winner")

Search and list products in the current store. Supports filtering by lifecycle_state (e.g. "active", "draft", "winner") or whether they have an active pending decision, sorting by recency or ROAS, and limiting results. Returns id, title, state, vendor, price, last decision, and current ROAS.

post/api/v1/tools/query_products

Request

  • Base URL: https://app.magistry.io
  • URL: https://app.magistry.io/api/v1/tools/query_products
  • 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: catalog:read)

Request body

sort'created_desc' | 'updated_desc' | 'roas_desc'

Sort order. Defaults to updated_desc.

limitinteger

Max results to return (default 10, max 50).

Response

Tool result

okboolean required
resultunknown required

Changes

No recorded changes to this operation across all 2 revisions of this API.