MailcrateDocs
Email templates

List email templates

GET
/public/email-template

Requires the email-template:read scope.

Authorization

ApiKey
headerAuthorization<token>

Api-Key mc_... — a workspace API key.

Query Parameters

query?string
type?string
usedIn?string
sendable?boolean
ids?array<>
limit?integer
Range1 <= value <= 500
Default50
offset?integer
Range0 <= value
Default0
page?integer
Range1 <= value
sortBy?string
sortOrder?string
Value in"ASC""DESC"

Response Body

A page of results.

application/json
  1. response
data*array<>
total*integer

Matches across all pages.

limit*integer
offset*integer

The offset actually applied, also when you paginated with page.

Example Request
curl -X GET 'https://api.mailcrate.io/public/email-template' \  -H 'Authorization: Api-Key <api_key>'
Example Response
{  "data": [    {      "id": "string",      "name": "string",      "slug": "string",      "type": "html",      "senderIdentityId": "string",      "subject": "string",      "preHeaderText": "string",      "html": "string",      "visualConfig": {},      "replyTo": "string",      "bcc": "string",      "variables": [        {}      ],      "compiledBundleVersion": 0,      "currentVersionId": "string",      "created": "2019-08-24T14:15:22Z",      "updated": "2019-08-24T14:15:22Z"    }  ],  "total": 0,  "limit": 0,  "offset": 0}

Get an email template GET

`identifier` is the template's id or its slug. Requires the `email-template:read` scope.

Push a compiled template bundle POST

Uploads a compiled React Email bundle as the template's new content. This is what `mailcrate push` calls; `changed` in the response is `false` when the bundle was identical to the current one. Requires the `email-template:write` scope.