For the complete documentation index, see llms.txt. This page is also available as Markdown.

Get System Email Templates

Get system email templates.

The Email channel handles transactional and campaign email — templates, footers, signatures, campaigns, and provider integrations.

This endpoint returns the system email templates available in your project.

Get system email templates

get
Authorizations
HTTPRequired

JWT Bearer Authorization

Path parameters
versionstring · nullableRequired

The CodeMash API version used to fetch data from the API. If not specified, the last version will be used. E.g.: v3

Query parameters
GroupTagsanyOptional

Optional group tags to filter templates by (e.g. newsletter, onboarding).

ThemesanyOptional

Optional visual themes to filter templates by.

CommunicationChannelCommunicationChannel · nullableOptional

Optional communication channel to filter templates by (e.g. Transactional, Marketing).

ForTriggerTriggerType · nullableOptional

Optional trigger type to filter templates that are designed for a specific automated trigger.

startingAfterstring · nullableOptional

Cursor token — fetch the page AFTER this item.

endingBeforestring · nullableOptional

Cursor token — fetch the page BEFORE this item.

pageSizeinteger · int32 · nullableOptional

Amount of records to return.

Header parameters
norbix-project-idstring · nullableRequired

ID of your project. Can be passed in a header as norbix-project-id.

norbix-envstring · nullableOptional

Target environment for this request (e.g. TEST, STAGING). Optional — when omitted the request runs against PROD. Can be passed in a header as norbix-env.

CultureCodestring · nullableOptional

Specify culture code when your response from the API should be localised. E.g.: en

TimeZoneIdstring · nullableOptional

TimeZone

CorrelationIdstring · nullableOptional

CorrelationId for each request

Responses
200

OK

application/json
get/{version}/notifications/email/system-templates
GET /{version}/notifications/email/system-templates HTTP/1.1
Host: hub.norbix.ai
Authorization: Bearer YOUR_SECRET_TOKEN
norbix-project-id: text
Accept: */*
200

OK

{
  "responseStatus": {
    "isSuccess": true
  },
  "list": {
    "items": [],
    "hasMore": true,
    "hasPrevious": true,
    "startingAfter": "text",
    "endingBefore": "text"
  }
}

In the dashboard

Manage this visually in Norbix Cloud — see Notifications.

Use it from code

Every Norbix SDK exposes this endpoint as a method — see Get System Email Templates in the SDK reference, with examples in every language.

Last updated