Sign in
Email Templates

List email templates

Returns a paginated list of account-scoped email templates. Archived templates are excluded unless requested.

get/public/v1/email-templates

Query parameters

pageSizenumber
Example:1
pageNumnumber
Example:1
number nullable
OR
string
OR
object nullable
Example:1
searchstring
Example:example
status'ACTIVE' | 'ARCHIVED'
Example:ACTIVE
includeArchivedboolean nullable

Response

Paginated email templates

countnumber
pageSizenumber required
pageNumnumber
totalPagesnumber

Example response

{
  "count": 1,
  "pageSize": 1,
  "pageNum": 1,
  "totalPages": 1,
  "results": [
    {
      "id": 1,
      "name": "example",
      "description": "example",
      "subject": "example",
      "bodyText": "example",
      "contentHash": "example",
      "status": "ACTIVE",
      "version": 1,
      "updatedAt": "example",
      "createdAt": "example",
      "createdBy": {
        "id": 1,
        "firstName": "example",
        "lastName": "example",
        "email": "user@example.com",
        "avatar": "example"
      },
      "updatedBy": {
        "id": 1,
        "firstName": "example",
        "lastName": "example",
        "email": "user@example.com",
        "avatar": "example"
      }
    }
  ]
}

Changes

Changed in 1 of the 2 revisions of this API.1