Skip to content
Frontmail Docs

List templates with their parameter schemas

GET
/v1/templates
curl --request GET \
  --url https://api.frontmail.dev/v1/templates \
  --header 'Authorization: Bearer <token>'

Used by npx frontmail types. Private key only.

Authorizations

Section titled “Authorizations”

Responses

Section titled “ Responses ”

200

Section titled “200”

Templates.

Media typeapplication/json
object
items
required
Array<object>
object
template_id
required
string
name
required
string
description
required
string | null
locale
required
string
version
required
integer
updated_at
required
string
params
required
Array<object>
object
name
required
string
label
string
description
string
type
required
string
Allowed values: string text email url number boolean date enum html list
required
required
boolean
default
sampleValue
enumValues
Array<string>
itemFields
Array<object> recursive
minLength
number
maxLength
number
min
number
max
number
pattern
string
Example
{
  "items": [
    {
      "params": [
        {
          "type": "string"
        }
      ]
    }
  ]
}

401

Section titled “401”

Missing or invalid key (unauthorized, invalid_public_key, invalid_private_key).

Media typeapplication/json
object
error
required
object
code
required

Stable error code. See https://docs.frontmail.dev/reference/errors/.

string
Allowed values: bad_request invalid_body invalid_idempotency_key unauthorized invalid_public_key invalid_private_key insufficient_credits forbidden origin_not_allowed captcha_required captcha_failed captcha_not_configured headless_blocked recipient_blocked private_key_required private_key_in_browser email_not_verified organization_suspended plan_limit_reached dynamic_recipient_not_allowed dynamic_recipient_requires_captcha dynamic_field_not_allowed link_not_allowed attachments_not_allowed not_found service_not_found template_not_found message_not_found conflict idempotency_conflict payload_too_large attachment_too_large invalid_template_params template_render_failed invalid_recipient service_unavailable_for_template sender_not_configured rate_limited test_send_limit recipient_suppressed internal_error provider_error service_unavailable
message
required
string
docs_url
required
string format: uri
details
Example
{
  "error": {
    "code": "invalid_template_params",
    "message": "Invalid template parameters. email: Enter a valid e-mail address.",
    "docs_url": "https://docs.frontmail.dev/reference/errors/#invalid-template-params",
    "details": {
      "issues": [
        {
          "param": "email",
          "code": "invalid_email",
          "message": "Enter a valid e-mail address."
        }
      ]
    }
  }
}

403

Section titled “403”

Forbidden: origin, CAPTCHA (required, failed, not configured), headless, block list, private key required, suspended, unverified owner e-mail, plan limit, dynamic recipient, attachments.

Media typeapplication/json
object
error
required
object
code
required

Stable error code. See https://docs.frontmail.dev/reference/errors/.

string
Allowed values: bad_request invalid_body invalid_idempotency_key unauthorized invalid_public_key invalid_private_key insufficient_credits forbidden origin_not_allowed captcha_required captcha_failed captcha_not_configured headless_blocked recipient_blocked private_key_required private_key_in_browser email_not_verified organization_suspended plan_limit_reached dynamic_recipient_not_allowed dynamic_recipient_requires_captcha dynamic_field_not_allowed link_not_allowed attachments_not_allowed not_found service_not_found template_not_found message_not_found conflict idempotency_conflict payload_too_large attachment_too_large invalid_template_params template_render_failed invalid_recipient service_unavailable_for_template sender_not_configured rate_limited test_send_limit recipient_suppressed internal_error provider_error service_unavailable
message
required
string
docs_url
required
string format: uri
details
Example
{
  "error": {
    "code": "invalid_template_params",
    "message": "Invalid template parameters. email: Enter a valid e-mail address.",
    "docs_url": "https://docs.frontmail.dev/reference/errors/#invalid-template-params",
    "details": {
      "issues": [
        {
          "param": "email",
          "code": "invalid_email",
          "message": "Enter a valid e-mail address."
        }
      ]
    }
  }
}

429

Section titled “429”

Rate limited – see Retry-After (seconds).

Media typeapplication/json
object
error
required
object
code
required

Stable error code. See https://docs.frontmail.dev/reference/errors/.

string
Allowed values: bad_request invalid_body invalid_idempotency_key unauthorized invalid_public_key invalid_private_key insufficient_credits forbidden origin_not_allowed captcha_required captcha_failed captcha_not_configured headless_blocked recipient_blocked private_key_required private_key_in_browser email_not_verified organization_suspended plan_limit_reached dynamic_recipient_not_allowed dynamic_recipient_requires_captcha dynamic_field_not_allowed link_not_allowed attachments_not_allowed not_found service_not_found template_not_found message_not_found conflict idempotency_conflict payload_too_large attachment_too_large invalid_template_params template_render_failed invalid_recipient service_unavailable_for_template sender_not_configured rate_limited test_send_limit recipient_suppressed internal_error provider_error service_unavailable
message
required
string
docs_url
required
string format: uri
details
Example
{
  "error": {
    "code": "invalid_template_params",
    "message": "Invalid template parameters. email: Enter a valid e-mail address.",
    "docs_url": "https://docs.frontmail.dev/reference/errors/#invalid-template-params",
    "details": {
      "issues": [
        {
          "param": "email",
          "code": "invalid_email",
          "message": "Enter a valid e-mail address."
        }
      ]
    }
  }
}

Headers

Section titled “Headers”
Retry-After
required

Seconds to wait before retrying.

string

Seconds to wait before retrying.

500

Section titled “500”

Unexpected error; details.request_id identifies the request.

Media typeapplication/json
object
error
required
object
code
required

Stable error code. See https://docs.frontmail.dev/reference/errors/.

string
Allowed values: bad_request invalid_body invalid_idempotency_key unauthorized invalid_public_key invalid_private_key insufficient_credits forbidden origin_not_allowed captcha_required captcha_failed captcha_not_configured headless_blocked recipient_blocked private_key_required private_key_in_browser email_not_verified organization_suspended plan_limit_reached dynamic_recipient_not_allowed dynamic_recipient_requires_captcha dynamic_field_not_allowed link_not_allowed attachments_not_allowed not_found service_not_found template_not_found message_not_found conflict idempotency_conflict payload_too_large attachment_too_large invalid_template_params template_render_failed invalid_recipient service_unavailable_for_template sender_not_configured rate_limited test_send_limit recipient_suppressed internal_error provider_error service_unavailable
message
required
string
docs_url
required
string format: uri
details
Example
{
  "error": {
    "code": "invalid_template_params",
    "message": "Invalid template parameters. email: Enter a valid e-mail address.",
    "docs_url": "https://docs.frontmail.dev/reference/errors/#invalid-template-params",
    "details": {
      "issues": [
        {
          "param": "email",
          "code": "invalid_email",
          "message": "Enter a valid e-mail address."
        }
      ]
    }
  }
}