Email

Get one email template (effective content)

Returns the template body that would be used when sending: project override if present, else global default, else built-in fallback. **`isProjectOverride`** is true only when this project has a stored row; **`effectiveSource`** is `project`, `global`, or `builtin`.

AuthJWT or API Key
GroupEmail
Rate limitSee Rate Limits
GET/api/projects/{projectId}/email/templates/{name}

SDK setup

Create a client and set credentials (JWT and/or API key) before calling the API. Match the authentication type shown above.

import { Configuration, EmailApi } from 'mudbase-sdk';

const configuration = new Configuration({
  basePath: 'https://cloud.mudbase.dev',
  apiKey: 'sk_live_mudbase_doc_Xk9mP2qR7vN4wL8jH3tY6uE',
  accessToken: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig',
});
// This endpoint accepts either credential — apiKey or accessToken alone is enough.

const email = new EmailApi(configuration);
import { Configuration, EmailApi } from 'mudbase-sdk';

const configuration = new Configuration({
  basePath: 'https://cloud.mudbase.dev',
  apiKey: 'sk_live_mudbase_doc_Xk9mP2qR7vN4wL8jH3tY6uE',
  accessToken: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig',
});
// This endpoint accepts either credential — apiKey or accessToken alone is enough.

const email = new EmailApi(configuration);

Example request

Call this endpoint using the client from SDK setup. Use View HTTP for a raw cURL example.

const { data: result } = await email.getProjectEmailTemplate("proj_PpF57uMEXQjL", "Ms. Ila McDermott");
const { data: result } = await email.getProjectEmailTemplate("proj_PpF57uMEXQjL", "Ms. Ila McDermott");

Playground

live

Test this endpoint with your own credentials. Your requests will be sent to the live API.

Get your API key from the console
Use the auth endpoints to obtain a JWT.

No Request Yet

Send a request to see the full inspector

Authentication

Requires JWT Requires API Key JWT or API Key
Note
This endpoint accepts either JWT Bearer token or API Key. Use Authorization: Bearer YOUR_TOKEN for user context, or X-API-Key: YOUR_KEY for server-to-server. View authentication guide →Include your JWT in the Authorization: Bearer YOUR_TOKEN header (user-facing apps, RBAC). View authentication guide →Include your API key in the X-API-Key: YOUR_KEY header (server-to-server, SDKs). View authentication guide →

Path Parameters

NameTypeRequiredDescription
projectIdstringYes—
namestringYes—

Responses

200Template document (resolved for send)

Project-customized template

json
{
  "success": true,
  "data": {
    "name": "magicLink",
    "subject": "Sign in to {{projectName}}",
    "htmlBody": "<h1>Sign in</h1><p><a href=\"{{magicLinkUrl}}\">Continue</a></p>",
    "textBody": "",
    "variables": [
      "userName",
      "magicLinkUrl",
      "projectName",
      "expiresIn"
    ],
    "updatedAt": "2025-04-01T12:00:00.000Z",
    "version": 2,
    "isProjectOverride": true,
    "effectiveSource": "project"
  }
}
{
  "success": true,
  "data": {
    "name": "magicLink",
    "subject": "Sign in to {{projectName}}",
    "htmlBody": "<h1>Sign in</h1><p><a href=\"{{magicLinkUrl}}\">Continue</a></p>",
    "textBody": "",
    "variables": [
      "userName",
      "magicLinkUrl",
      "projectName",
      "expiresIn"
    ],
    "updatedAt": "2025-04-01T12:00:00.000Z",
    "version": 2,
    "isProjectOverride": true,
    "effectiveSource": "project"
  }
}

Built-in default (no DB row for project)

json
{
  "success": true,
  "data": {
    "name": "emailVerification",
    "subject": "Verify your email address",
    "htmlBody": "<h1>Verify your email</h1><p>Hi {{userName}},</p><p><a href=\"{{verificationUrl}}\">Verify Email</a></p>",
    "textBody": "",
    "variables": [],
    "updatedAt": null,
    "version": null,
    "isProjectOverride": false,
    "effectiveSource": "builtin"
  }
}
{
  "success": true,
  "data": {
    "name": "emailVerification",
    "subject": "Verify your email address",
    "htmlBody": "<h1>Verify your email</h1><p>Hi {{userName}},</p><p><a href=\"{{verificationUrl}}\">Verify Email</a></p>",
    "textBody": "",
    "variables": [],
    "updatedAt": null,
    "version": null,
    "isProjectOverride": false,
    "effectiveSource": "builtin"
  }
}
404—

Errors

CodeMeaning
404—
Run in PostmanDownload OpenAPI

Next

NEXT →API Reference OverviewBase URL, rate limits, pagination, and the full endpoint index.NEXT →AuthenticationAPI keys, Bearer tokens, and user sessions.NEXT →API PlaygroundSearch any endpoint and send a live request.
Edit this page on GitHub