Get the email component schema

Returns the full schema for email design sections including all component types, their props, required fields, and defaults. Sourced from config/email_components.yml.

GET /v1/my/templates/spec

Get the email component schema

cURL

curl --request GET \
  --url https://api.nitrosend.com/v1/my/templates/spec \
  --header 'Authorization: Bearer <token>'

200

{
  "version": 123,
  "design_guidelines": "<string>",
  "components": [
    {
      "type": "<string>",
      "description": "<string>",
      "tips": [
        "<string>"
      ],
      "props": {}
    }
  ],
  "common_styles": {},
  "variables": [
    "<string>"
  ],
  "theme_fields": [
    "<string>"
  ]
}

Authorizations

Authorization · string · header · required

API key (nskey_live_...) or JWT token. API key is checked first; if not found, falls back to Devise JWT authentication.

Response

200 - application/json

Email component schema

Full schema for email design sections. Each component has type, description, props (with types, required flags, defaults), and tips.

version · integer

design_guidelines · string

components · object[]

Show child attributes

common_styles · object

variables · string[]

theme_fields · string[]