Skip to main content

​
Endpoint

GET /api/v1/templates/{template_code}

​
Description

Retrieves a notification template by its unique code. Templates contain the subject, body, and required variables for email or push notifications.

​
Authentication

This endpoint may require authentication depending on your system configuration.

​
Path Parameters

​
template_code
string
required
The unique code identifying the template.Example: welcome_email, password_reset, account_deactivatedAvailable templates:
  • welcome_email - Welcome message for new users
  • password_reset - Password reset instructions
  • account_deactivated - Account deactivation confirmation

​
Response

​
success
boolean
Indicates whether the request was successfulValue: true
​
data
object
Template data object
​
message
string
Human-readable message describing the resultExample: Template fetched successfully

​
Error Responses

​
404 Not Found
error
Returned when the template with the specified code does not exist.
{
  "detail": "Template not found"
}

​
Example Request

curl http://localhost:8002/api/v1/templates/welcome_email

​
Example Response

Welcome Email Template
{
  "success": true,
  "data": {
    "subject": "Welcome to Our Platform!",
    "body": "Hi {{name}},\n\nThanks for signing up. We're glad to have you onboard!",
    "version": "2.0.0",
    "variables": ["name"]
  },
  "message": "Template fetched successfully"
}
Password Reset Template
{
  "success": true,
  "data": {
    "subject": "Reset Your Password",
    "body": "Hi {{name}},\n\nClick here to reset your password: {{link}}",
    "version": "1.5.4",
    "variables": ["name", "link"]
  },
  "message": "Template fetched successfully"
}
Account Deactivated Template
{
  "success": true,
  "data": {
    "subject": "Your Account Has Been Deactivated",
    "body": "Hi {{name}},\n\nWe noticed you deactivated your account. We hope to see you back soon.",
    "version": "1.0.0",
    "variables": ["name"]
  },
  "message": "Template fetched successfully"
}
404 Not Found
{
  "detail": "Template not found"
}

​
Available Templates

​
welcome_email

Sent to new users after registration.
  • Subject: Welcome to Our Platform!
  • Required variables: name
  • Version: 2.0.0

​
password_reset

Sent when a user requests a password reset.
  • Subject: Reset Your Password
  • Required variables: name, link
  • Version: 1.5.4

​
account_deactivated

Sent when a user deactivates their account.
  • Subject: Your Account Has Been Deactivated
  • Required variables: name
  • Version: 1.0.0

​
Template Variables

Variables in templates use the {{variable_name}} syntax and are replaced at runtime when sending notifications. All required variables must be provided in the notification request. Common variables:
  • {{name}} - User’s full name
  • {{link}} - Action URL or link
  • {{email}} - User’s email address

​
Notes

  • Templates are stored in templates.json and loaded at runtime
  • Future versions may support database storage and dynamic template creation
  • Templates can be cached in Redis for faster access
  • Version numbers follow semantic versioning (MAJOR.MINOR.PATCH)
  • The API Gateway fetches templates when processing notification requests
  • Missing or incorrect variables will cause notification processing to fail

Build docs developers (and LLMs) love

Get started for freeTalk to us