Get email template by ID

GET /api/email-templates/{id}

OAuth2

Get the email template by its ID.

Path parameters

id string Required

The unique identifier of the email template.

Responses

200 application/json

The email template.
Hide response attributes Show response attributes object
- tenantId string Required
  
  Maximum length is 21.
- id string Required
  
  Minimum length is 1, maximum length is 21.
- languageTag string Required
  
  Minimum length is 1, maximum length is 16.
- templateType string Required
  
  Values are SignIn, Register, ForgotPassword, OrganizationInvitation, Generic, UserPermissionValidation, or BindNewIdentifier.
- details object Required
  
  Additional properties are allowed.
  
  Hide details attributes Show details attributes object
  
  subject string Required
  
  content string Required
  
  contentType string("text/html") | string("text/plain")
  
  One of:
  string-1 string("text/html") string-2 string("text/plain")
  
  replyTo string
  
  sendFrom string
- createdAt number Required
400

Bad Request
401

Unauthorized
403

Forbidden
404

The email template was not found.

GET /api/email-templates/{id}

curl \
 --request GET https://[tenant_id].logto.app/api/email-templates/{id} \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "tenantId": "string",
  "id": "string",
  "languageTag": "string",
  "templateType": "SignIn",
  "details": {
    "subject": "string",
    "content": "string",
    "contentType": "string",
    "replyTo": "string",
    "sendFrom": "string"
  },
  "createdAt": 42.0
}

Get email template by ID

Path parameters

Responses

contentType string("text/html") | string("text/plain")