Sign in

v1

latestOpenAPI 3.1.02026-07-24700259.3 KB
TEMPLATES

View email templates

Search your collection of email templates. Returns any templates that match your search criteria.

post/template/search

Request body

fuzzy_searchboolean

If provided, will determine whether search terms are matched exactly or using wildcards. Default: false

search_termsstring[]

If provided, will return email templates containing any of the strings provided in name, tag, id or subject fields.

tagsstring[]

If provided, will return email templates containing any of the tags provided

sort_directionstring

If provided, will sort the returned email templates in ascending or descending order. Default: asc<br><br><strong>Values:</strong> asc or desc

page_sizeinteger

If provided, will limit the number of email templates returned. Default 100

continue_tokenstring

If provided, will fetch the next page of results, following on from the previous page of results from which this continue token was returned

Response

Matching templates

request_idstring

Example response

{
  "request_id": "13ab6f3a-ddea-11eb-b4ce-1002b51e60a4",
  "data": {
    "templates": [
      {
        "id": "5355878",
        "name": "Order receipt",
        "template_name": "Order receipt",
        "subject": "Order receipt for {{ product_name }}",
        "tags": [
          "one"
        ],
        "last_updated": "2024-01-01 12:00:00"
      }
    ]
  }
}