Email

List email templates (full catalog for the project)

Returns every template name the worker can resolve for this project: **built-in** defaults, **global** platform rows (`project: null` in DB), and **project** overrides. Use **`isCustomized`** to see if this project has its own stored copy; **`effectiveSource`** shows which layer would be used at send time (`project` wins over `global` over `builtin`).

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

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.listProjectEmailTemplates("proj_KoP3NYh01S87");
const { data: result } = await email.listProjectEmailTemplates("proj_KoP3NYh01S87");

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—

Responses

200Template catalog with customization flags
json
{
  "success": true,
  "data": [
    {
      "name": "emailVerification",
      "isCustomized": false,
      "effectiveSource": "builtin",
      "subjectSnippet": "Verify your email address",
      "updatedAt": null,
      "version": null
    },
    {
      "name": "magicLink",
      "isCustomized": true,
      "effectiveSource": "project",
      "subjectSnippet": "Your magic link — Acme App",
      "updatedAt": "2025-04-01T12:00:00.000Z",
      "version": 2
    },
    {
      "name": "welcome",
      "isCustomized": false,
      "effectiveSource": "global",
      "subjectSnippet": "Welcome to MUDBASE",
      "updatedAt": "2025-03-10T09:00:00.000Z",
      "version": 1
    }
  ]
}
{
  "success": true,
  "data": [
    {
      "name": "emailVerification",
      "isCustomized": false,
      "effectiveSource": "builtin",
      "subjectSnippet": "Verify your email address",
      "updatedAt": null,
      "version": null
    },
    {
      "name": "magicLink",
      "isCustomized": true,
      "effectiveSource": "project",
      "subjectSnippet": "Your magic link — Acme App",
      "updatedAt": "2025-04-01T12:00:00.000Z",
      "version": 2
    },
    {
      "name": "welcome",
      "isCustomized": false,
      "effectiveSource": "global",
      "subjectSnippet": "Welcome to MUDBASE",
      "updatedAt": "2025-03-10T09:00:00.000Z",
      "version": 1
    }
  ]
}
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