List active templates

GET

/api/v3/letters/templates/active

Using the v3 api, which requires a company-level API key, you can list all of your active newsletter templates.

Authorizations

• bearerAuth

Parameters

Query Parameters

api

string

Example

true

required | When set to true, this endpoint will accept authorization with your API Key.

channels[]

string

Example

letterhead-example-newsletter

required | string[] | An array of channel identifiers (or channel “slugs”).

Request Body

Media type multipart/form-data

object

Responses

200

200 Active templates

Media type application/json

object

items

Array<object>

object

abTestMetrics

Array

abTestUuid

string

automationUniqueId

string

blocks

Array

brandName

string

brandSlug

string

campaignId

string

channelId

number

channelName

string

channelSlug

string

claimant

string

commentCount

number

copyRendered

string

createdAt

string

deletedAt

nullable

delta

string

emailTemplate

string

esp

string

hasAbTest

boolean

id

number

includePromotions

boolean

insights

Array

isClaimed

boolean

isCompanyLetter

boolean

openGraphDescription

string

openGraphHeadline

string

openGraphImageUrl

string

private

boolean

promotions

Array

publicationDate

string

publicationDateOffset

string

publicationDateTzCode

string

publicationEvent

string

publicationStatus

number

publishIntent

string

publishingRetries

number

segmentId

number

segmentName

string

settings

object

sharedChannels

Array

subjectB

string

subtitle

string

title

string

uniqueId

string

updatedAt

string

useComposer

boolean

message

string

total

number

Examples

Example 200 Active templates

{
  "items": [
    {
      "abTestMetrics": [],
      "abTestUuid": "",
      "automationUniqueId": "",
      "blocks": [],
      "brandName": "My Brand",
      "brandSlug": "my-brand",
      "campaignId": "",
      "channelId": 123,
      "channelName": "My Channel",
      "channelSlug": "my-channel-slug",
      "claimant": "",
      "commentCount": 0,
      "copyRendered": "",
      "createdAt": "2026-01-15 10:00:00",
      "deletedAt": null,
      "delta": "",
      "emailTemplate": "",
      "esp": "",
      "hasAbTest": false,
      "id": 456,
      "includePromotions": false,
      "insights": [],
      "isClaimed": false,
      "isCompanyLetter": true,
      "openGraphDescription": "",
      "openGraphHeadline": "",
      "openGraphImageUrl": "",
      "private": false,
      "promotions": [],
      "publicationDate": "",
      "publicationDateOffset": "",
      "publicationDateTzCode": "",
      "publicationEvent": "",
      "publicationStatus": 9,
      "publishIntent": "",
      "publishingRetries": 0,
      "segmentId": 0,
      "segmentName": "",
      "settings": {},
      "sharedChannels": [],
      "subjectB": "",
      "subtitle": "Template subtitle",
      "title": "My Template",
      "uniqueId": "abc-123-def-456",
      "updatedAt": "2026-02-20 14:30:00",
      "useComposer": false
    }
  ],
  "message": "Active templates retrieved.",
  "total": 1
}