Sign in
Email Blocks

Get email block type

Returns the full field reference for one block type, with a minimal valid example and authoring notes.

get/email-blocks/{type}

Path parameters

typestring required

Block type, for example list, steps, text, or hero.

Query parameters

conditionFields'true'

Include the per-field condition table in the response. Not needed for conditional-group, which always carries it. The table is several times the size of one block type's reference, so a targeted lookup does not carry it unless asked.

Response

Block type reference

successboolean
conditionFieldsHintstring

Returned in place of conditionFields when the table was not included, saying that conditions are per-field and how to request the table.

Example response

{
  "success": true,
  "blockType": {
    "type": "steps",
    "required": [
      "items",
      "variant"
    ],
    "optional": [
      "id",
      "accentColor",
      "styles",
      "conditions"
    ],
    "fields": [
      {
        "name": "variant",
        "type": "enum",
        "values": [
          "numbered",
          "timeline"
        ]
      }
    ]
  },
  "conditionFields": [
    {
      "field": "tag",
      "label": "Tag",
      "operators": [
        "contains",
        "not_contains",
        "is_empty",
        "is_not_empty"
      ]
    }
  ],
  "conditionFieldsHint": "Every block also takes a `conditions` array, and each condition field accepts only its own operators. Request this endpoint with ?conditionFields=true, or GET /email-blocks, for `conditionFields`: the operators, value format, and render-preview support of every condition field."
}

Changes