Skip to main content
GET
Get Email Block Type
You can read the complete field reference for a single block type, including a minimal valid example and authoring notes. Each entry in fields describes one field. An array field carries itemFields with the shape of one entry, and an object field carries its own fields - so GET /api/v1/email-blocks/repeat returns the mode, strategy, lookbackDays, sort, and filters a productSource accepts, with the allowed values of each. The response carries conditionFields, the per-field table for block conditions, when you request conditional-group or pass ?conditionFields=true. Any other type returns conditionFieldsHint instead, because the table is several times the size of one block type’s reference and a targeted lookup should stay small. See List Email Block Types.
For line-items, the optional itemFields object maps title, variantTitle, quantity, priceCents, price, imageUrl, url, and currency to dotted paths relative to one item. For example, {"itemFields":{"title":"product.name","quantity":"count"}}. Omitted or blank entries use the standard field name. Paths accept up to 200 characters; non-string or longer mappings fail block validation. Numeric priceCents uses cents by default; set priceUnit: "major" explicitly for major-unit values; price is a formatted fallback. The CLI sequenzy blocks line-items and MCP get_email_block_schema return this same field reference. See Cart and Order Blocks.

Request

string
required
Block type, for example list, steps, text, or hero.
string
Pass true to include the per-field condition table. Not needed for conditional-group, which always carries it.

Responses

Cart design fields include imageSize, imageFit, rowSpacing, fontSize, showPrices, showCompareAtPrice (default false; strikes through each item’s compareAtPriceCents under its price when higher) and priceLocale (a BCP 47 locale such as de-DE or es-ES for prices and the total, so 4995 in EUR renders 49,95 €; omit it to follow the email’s language, the company language or the translation’s locale, so English emails show €49.95). Preview Cart Items returns presets, mapping suggestions and scenario data without saving.