--- title: "Read an email template's draft, published version and history" description: "Returns the draft, the published version and every version of one message's template at one scope and language. A message with no override at that scope answers with no versions and inherits its wording.\n\n### Quire permissions\n\nRequired capability: `email_template/edit`.\n\nCredential scopes: `email:read`.\n\nThe acting subject must also be allowed to perform this action in the organisation." image: "https://docs.quirelms.com/og.png" --- > Documentation Index > Fetch the complete documentation index at: https://docs.quirelms.com/llms.txt > Use this file to discover all available pages before exploring further. Path: Quire API › email `GET /email_templates/{message_key}/versions` Returns the draft, the published version and every version of one message's template at one scope and language. A message with no override at that scope answers with no versions and inherits its wording. \### Quire permissions Required capability: `email_template/edit`. Credential scopes: `email:read`. The acting subject must also be allowed to perform this action in the organisation. ## Authentication Requires one of the following: - `apiKey`, http, header `Authorization`, scopes: `email:read` - `oauth2`, oauth2, scopes: `email:read` ## Path parameters - `listEmailTemplateVersions.path.message_key` (string, required) ## Query parameters - `listEmailTemplateVersions.query.language` (string, required) — The BCP 47 language of the template, for example en or fr-CA. - minLength 1; maxLength 35; pattern `^[A-Za-z]{2,3}(-[A-Za-z0-9]{2,8})*$` - `listEmailTemplateVersions.query.level` (string, optional) — Where the override applies. Defaults to tenant. - one of `"tenant"`, `"category"`, `"course"`, `"activity"` - `listEmailTemplateVersions.query.scope_id` (string, optional) — The category, course or activity the override applies to. Required unless level is tenant, and refused when it is. - format `uuid`; pattern `^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$` ## Header parameters - `listEmailTemplateVersions.header.Quire-Version` (string, optional) — The dated API revision to serve this request at. Omitted, the request is served at the revision the credential was issued against. The response echoes the revision actually applied. - format `date` ## Code samples ### cURL ```curl curl --request GET \ --url 'https://your-organisation.quirelms.com/api/v1/email_templates/string/versions?language=string' \ --header 'Authorization: Bearer ' ``` ### TypeScript ```typescript const url = 'https://your-organisation.quirelms.com/api/v1/email_templates/string/versions?language=string'; const options = {method: 'GET', headers: {Authorization: 'Bearer '}}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error(err)); ``` ### Python ```python import requests url = "https://your-organisation.quirelms.com/api/v1/email_templates/string/versions?language=string" headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers) print(response.text) ``` ## Responses ### 200 Success. #### Example ```json { "message_key": "string", "title": "string", "description": "string", "category": "string", "critical": true, "scope": { "level": "tenant", "scope_id": "5d3fe357-12dd-4f62-b004-6d1fb3b8454f", "language": "string" }, "template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc", "draft": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "version": -9007199254740991, "state": "draft", "subject": "string", "preheader": "string", "from_name": "string", "reply_to": "string", "variable_refs": [ "string" ], "text_part": "string", "body": "string", "created_at": "2019-08-24T14:15:22Z", "published_at": "2019-08-24T14:15:22Z" }, "published": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "version": -9007199254740991, "state": "draft", "subject": "string", "preheader": "string", "from_name": "string", "reply_to": "string", "variable_refs": [ "string" ], "text_part": "string", "body": "string", "created_at": "2019-08-24T14:15:22Z", "published_at": "2019-08-24T14:15:22Z" }, "versions": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "version": -9007199254740991, "state": "draft", "subject": "string", "preheader": "string", "from_name": "string", "reply_to": "string", "variable_refs": [ "string" ], "text_part": "string", "body": "string", "created_at": "2019-08-24T14:15:22Z", "published_at": "2019-08-24T14:15:22Z" } ], "may_edit_source": true } ``` - `listEmailTemplateVersions.response.200.message_key` (string, required) - `listEmailTemplateVersions.response.200.title` (string, required) - `listEmailTemplateVersions.response.200.description` (string, required) - `listEmailTemplateVersions.response.200.category` (string, required) - `listEmailTemplateVersions.response.200.critical` (boolean, required) - `listEmailTemplateVersions.response.200.scope` (object, required) - `listEmailTemplateVersions.response.200.scope.level` (string, required) - one of `"tenant"`, `"category"`, `"course"`, `"activity"` - `listEmailTemplateVersions.response.200.scope.scope_id` (any of, required) - any of: `string`, `null` - `listEmailTemplateVersions.response.200.scope.language` (string, required) - `listEmailTemplateVersions.response.200.template_id` (any of, required) - any of: `string`, `null` - `listEmailTemplateVersions.response.200.draft` (any of, required) - any of: `object`, `null` - `listEmailTemplateVersions.response.200.published` (any of, required) - any of: `object`, `null` - `listEmailTemplateVersions.response.200.versions` (array, required) - `listEmailTemplateVersions.response.200.versions.id` (string, required) - format `uuid`; pattern `^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$` - `listEmailTemplateVersions.response.200.versions.version` (integer, required) - min -9007199254740991; max 9007199254740991 - `listEmailTemplateVersions.response.200.versions.state` (string, required) - one of `"draft"`, `"published"`, `"archived"` - `listEmailTemplateVersions.response.200.versions.subject` (string | null, required) - `listEmailTemplateVersions.response.200.versions.preheader` (string | null, required) - `listEmailTemplateVersions.response.200.versions.from_name` (string | null, required) - `listEmailTemplateVersions.response.200.versions.reply_to` (string | null, required) - `listEmailTemplateVersions.response.200.versions.variable_refs` (array, required) - `listEmailTemplateVersions.response.200.versions.text_part` (string | null, required) - `listEmailTemplateVersions.response.200.versions.body` (string | null, required) — The block document or MJML source as JSON text, or null to inherit. - `listEmailTemplateVersions.response.200.versions.created_at` (string, required) - format `date-time`; pattern `^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$` - `listEmailTemplateVersions.response.200.versions.published_at` (any of, required) - any of: `string`, `null` - `listEmailTemplateVersions.response.200.may_edit_source` (boolean, required) ### 401 The credential is missing, malformed, expired or revoked. #### Example ```json { "type": "http://example.com", "title": "string", "status": 0, "code": "string", "category": "validation", "detail": "string", "request_id": "string", "errors": [ { "path": "string", "code": "string", "detail": "string" } ], "retry_after": 0, "docs_url": "http://example.com" } ``` - `listEmailTemplateVersions.response.401.type` (string, required) - format `uri` - `listEmailTemplateVersions.response.401.title` (string, required) - `listEmailTemplateVersions.response.401.status` (integer, required) - `listEmailTemplateVersions.response.401.code` (string, required) - `listEmailTemplateVersions.response.401.category` (string, required) - one of `"validation"`, `"authentication"`, `"authorization"`, `"not_found"`, `"conflict"`, `"precondition"`, `"quota"`, `"rate_limit"`, `"upstream"`, `"internal"` - `listEmailTemplateVersions.response.401.detail` (string, required) - `listEmailTemplateVersions.response.401.request_id` (string, required) - `listEmailTemplateVersions.response.401.docs_url` (string, required) - format `uri` - `listEmailTemplateVersions.response.401.errors` (array, optional) - `listEmailTemplateVersions.response.401.errors.path` (string, required) — RFC 6901 JSON Pointer into the request body. - `listEmailTemplateVersions.response.401.errors.code` (string, required) - `listEmailTemplateVersions.response.401.errors.detail` (string, required) - `listEmailTemplateVersions.response.401.retry_after` (integer | null, optional) ### 403 The credential lacks the scope this operation requires, or the acting subject lacks the capability. #### Example ```json { "type": "http://example.com", "title": "string", "status": 0, "code": "string", "category": "validation", "detail": "string", "request_id": "string", "errors": [ { "path": "string", "code": "string", "detail": "string" } ], "retry_after": 0, "docs_url": "http://example.com" } ``` - `listEmailTemplateVersions.response.403.type` (string, required) - format `uri` - `listEmailTemplateVersions.response.403.title` (string, required) - `listEmailTemplateVersions.response.403.status` (integer, required) - `listEmailTemplateVersions.response.403.code` (string, required) - `listEmailTemplateVersions.response.403.category` (string, required) - one of `"validation"`, `"authentication"`, `"authorization"`, `"not_found"`, `"conflict"`, `"precondition"`, `"quota"`, `"rate_limit"`, `"upstream"`, `"internal"` - `listEmailTemplateVersions.response.403.detail` (string, required) - `listEmailTemplateVersions.response.403.request_id` (string, required) - `listEmailTemplateVersions.response.403.docs_url` (string, required) - format `uri` - `listEmailTemplateVersions.response.403.errors` (array, optional) - `listEmailTemplateVersions.response.403.errors.path` (string, required) — RFC 6901 JSON Pointer into the request body. - `listEmailTemplateVersions.response.403.errors.code` (string, required) - `listEmailTemplateVersions.response.403.errors.detail` (string, required) - `listEmailTemplateVersions.response.403.retry_after` (integer | null, optional) ### 404 No such resource, or none this credential is permitted to know about. #### Example ```json { "type": "http://example.com", "title": "string", "status": 0, "code": "string", "category": "validation", "detail": "string", "request_id": "string", "errors": [ { "path": "string", "code": "string", "detail": "string" } ], "retry_after": 0, "docs_url": "http://example.com" } ``` - `listEmailTemplateVersions.response.404.type` (string, required) - format `uri` - `listEmailTemplateVersions.response.404.title` (string, required) - `listEmailTemplateVersions.response.404.status` (integer, required) - `listEmailTemplateVersions.response.404.code` (string, required) - `listEmailTemplateVersions.response.404.category` (string, required) - one of `"validation"`, `"authentication"`, `"authorization"`, `"not_found"`, `"conflict"`, `"precondition"`, `"quota"`, `"rate_limit"`, `"upstream"`, `"internal"` - `listEmailTemplateVersions.response.404.detail` (string, required) - `listEmailTemplateVersions.response.404.request_id` (string, required) - `listEmailTemplateVersions.response.404.docs_url` (string, required) - format `uri` - `listEmailTemplateVersions.response.404.errors` (array, optional) - `listEmailTemplateVersions.response.404.errors.path` (string, required) — RFC 6901 JSON Pointer into the request body. - `listEmailTemplateVersions.response.404.errors.code` (string, required) - `listEmailTemplateVersions.response.404.errors.detail` (string, required) - `listEmailTemplateVersions.response.404.retry_after` (integer | null, optional) ### 422 The request was understood and its content is not valid. `errors` names each field. #### Example ```json { "type": "http://example.com", "title": "string", "status": 0, "code": "string", "category": "validation", "detail": "string", "request_id": "string", "errors": [ { "path": "string", "code": "string", "detail": "string" } ], "retry_after": 0, "docs_url": "http://example.com" } ``` - `listEmailTemplateVersions.response.422.type` (string, required) - format `uri` - `listEmailTemplateVersions.response.422.title` (string, required) - `listEmailTemplateVersions.response.422.status` (integer, required) - `listEmailTemplateVersions.response.422.code` (string, required) - `listEmailTemplateVersions.response.422.category` (string, required) - one of `"validation"`, `"authentication"`, `"authorization"`, `"not_found"`, `"conflict"`, `"precondition"`, `"quota"`, `"rate_limit"`, `"upstream"`, `"internal"` - `listEmailTemplateVersions.response.422.detail` (string, required) - `listEmailTemplateVersions.response.422.request_id` (string, required) - `listEmailTemplateVersions.response.422.docs_url` (string, required) - format `uri` - `listEmailTemplateVersions.response.422.errors` (array, optional) - `listEmailTemplateVersions.response.422.errors.path` (string, required) — RFC 6901 JSON Pointer into the request body. - `listEmailTemplateVersions.response.422.errors.code` (string, required) - `listEmailTemplateVersions.response.422.errors.detail` (string, required) - `listEmailTemplateVersions.response.422.retry_after` (integer | null, optional) ### 429 A rate limit or a concurrency cap was reached. `Retry-After` says when to try again. #### Example ```json { "type": "http://example.com", "title": "string", "status": 0, "code": "string", "category": "validation", "detail": "string", "request_id": "string", "errors": [ { "path": "string", "code": "string", "detail": "string" } ], "retry_after": 0, "docs_url": "http://example.com" } ``` - `listEmailTemplateVersions.response.429.type` (string, required) - format `uri` - `listEmailTemplateVersions.response.429.title` (string, required) - `listEmailTemplateVersions.response.429.status` (integer, required) - `listEmailTemplateVersions.response.429.code` (string, required) - `listEmailTemplateVersions.response.429.category` (string, required) - one of `"validation"`, `"authentication"`, `"authorization"`, `"not_found"`, `"conflict"`, `"precondition"`, `"quota"`, `"rate_limit"`, `"upstream"`, `"internal"` - `listEmailTemplateVersions.response.429.detail` (string, required) - `listEmailTemplateVersions.response.429.request_id` (string, required) - `listEmailTemplateVersions.response.429.docs_url` (string, required) - format `uri` - `listEmailTemplateVersions.response.429.errors` (array, optional) - `listEmailTemplateVersions.response.429.errors.path` (string, required) — RFC 6901 JSON Pointer into the request body. - `listEmailTemplateVersions.response.429.errors.code` (string, required) - `listEmailTemplateVersions.response.429.errors.detail` (string, required) - `listEmailTemplateVersions.response.429.retry_after` (integer | null, optional) ### 500 Something failed at our end. Quote `request_id` when reporting it. #### Example ```json { "type": "http://example.com", "title": "string", "status": 0, "code": "string", "category": "validation", "detail": "string", "request_id": "string", "errors": [ { "path": "string", "code": "string", "detail": "string" } ], "retry_after": 0, "docs_url": "http://example.com" } ``` - `listEmailTemplateVersions.response.500.type` (string, required) - format `uri` - `listEmailTemplateVersions.response.500.title` (string, required) - `listEmailTemplateVersions.response.500.status` (integer, required) - `listEmailTemplateVersions.response.500.code` (string, required) - `listEmailTemplateVersions.response.500.category` (string, required) - one of `"validation"`, `"authentication"`, `"authorization"`, `"not_found"`, `"conflict"`, `"precondition"`, `"quota"`, `"rate_limit"`, `"upstream"`, `"internal"` - `listEmailTemplateVersions.response.500.detail` (string, required) - `listEmailTemplateVersions.response.500.request_id` (string, required) - `listEmailTemplateVersions.response.500.docs_url` (string, required) - format `uri` - `listEmailTemplateVersions.response.500.errors` (array, optional) - `listEmailTemplateVersions.response.500.errors.path` (string, required) — RFC 6901 JSON Pointer into the request body. - `listEmailTemplateVersions.response.500.errors.code` (string, required) - `listEmailTemplateVersions.response.500.errors.detail` (string, required) - `listEmailTemplateVersions.response.500.retry_after` (integer | null, optional) Source: https://docs.quirelms.com/api/email/listEmailTemplateVersions/index.md