Get email template by ID

Overview

Get a single email template by id. When you supply store_id the template's html_content has its placeholders resolved against that store.

Prerequisites

A bearer token in the Authorization header.
The emailTemplateId of the record you are targeting.

Base URL

Environment	URL
Production	`https://production-api.shoutaboutus.com`
Development	`https://development-api.shoutaboutus.com`

Endpoint

GET /api/v1/campaign/template/email/{emailTemplateId}

Authentication

Requires a bearer token in the Authorization: Bearer <bearer-token> header.
bearer token, account role — authentication. The template must belong to the caller's account or be a global template; otherwise validation fails.

Rate limit

No rate limit.

Path parameters

Parameter	Type	Required	Description
`emailTemplateId`	integer	Required	Digits only. Must belong to your own company.

Query parameters

Field	Type	Required	Description
`store_id`	integer	Optional	Resolve HTML placeholders against this store. Must be in the caller's hierarchy.

How it works

Synchronous. 200 OK with the full model under data.data. 404 (envelope) if the id is not found by the controller. 422 if the template is outside the caller's account or store_id is invalid.

Response

200 OK · `200`

{
  "data": {
    "status": "success",
    "data": {
      "id": 1,
      "company_id": 30,
      "store_id": 123,
      "name": "Welcome Email Template",
      "subject": "Welcome to our service!",
      "html_content": "<html><body><h1>Welcome!</h1></body></html>",
      "json_content": {},
      "template_editor_mode": "custom",
      "template_type": "regular",
      "manager_email": "[email protected]",
      "other_manager_email": [
        "[email protected]"
      ],
      "created_at": "2026-07-09T10:30:00.000000Z",
      "updated_at": "2026-07-09T10:30:00.000000Z",
      "deleted_at": null
    }
  }
}

404 Not found · `404`

{
  "message": "Email template not found",
  "status": "error",
  "errors": []
}

Errors

Status	Meaning
`401`	The bearer token is missing, expired or invalid
`404`	Not found
`422`	Returned if the template is outside the caller's account or `store_id` is invalid
`500`	Unexpected server error

Example request

curl --request GET \
  --url "https://production-api.shoutaboutus.com/api/v1/campaign/template/email/123?store_id=123" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json'

Updated 11 days ago

Did this page help you?