fc5624c7d57a

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-13260150938.9 KB
Email Components

List email components

Lists reusable email components newest first, including the components pinned as company defaults.

get/email-components

Query parameters

type'section' | 'footer'

Filter by component type.

slot'footer'

Filter by default slot.

defaultsOnly'true'

Return only components pinned as a company default.

Response

Components listed

successboolean

Example response

{
  "success": true,
  "components": [
    {
      "id": "cmp_123",
      "companyId": "company_123",
      "name": "Default Footer",
      "blocks": [
        {
          "id": "block_123",
          "type": "html",
          "content": "<h1>Hello</h1>",
          "styles": {
            "backgroundColor": "#f8fafc",
            "backgroundOpacity": 80,
            "textColor": "#111827",
            "borderRadius": 12,
            "borderColor": "#cbd5e1",
            "borderWidth": 1
          },
          "conditions": [
            {
              "id": "c1",
              "value": "plan:pro"
            }
          ]
        }
      ],
      "componentType": "footer",
      "defaultSlot": "footer",
      "version": 3
    }
  ]
}