List email templates
Overview
Get email templates selectable for the caller as a {value, label} dropdown source. The list combines the given store's templates (when you provide store_id), the caller account's templates, and global templates (where company_id is NULL). Results are sorted by name.
Prerequisites
- A bearer token in the
Authorizationheader.
Base URL
| Environment | URL |
|---|---|
| Production | https://production-api.shoutaboutus.com |
| Development | https://development-api.shoutaboutus.com |
Endpoint
GET /api/v1/campaign/template/email/list
Authentication
-
Requires a bearer token in the
Authorization: Bearer <bearer-token>header. -
bearer token, account role — authentication. The endpoint scopes company templates to
user.person.company_id;store_id(optional) must belong to the caller's account hierarchy.
Rate limit
- No rate limit.
Query parameters
| Field | Type | Required | Description |
|---|---|---|---|
store_id | integer | Optional | Also include templates scoped to this store. Must be in the caller's hierarchy (an ownership check). |
template_type | string | Optional | Filter to regular or follow_up. |
How it works
- Synchronous, not paginated.
200 OKwithdata.response= array of{value, label}.422on invalidstore_id.
Response
200 OK · 200
200{
"data": {
"status": "success",
"response": [
{
"value": 1,
"label": "Welcome Email Template"
},
{
"value": 2,
"label": "Follow-up Email Template"
}
]
}
}Errors
| Status | Meaning |
|---|---|
401 | The bearer token is missing, expired or invalid |
422 | Returned on invalid store_id |
500 | Unexpected server error |
Example request
curl --request GET \
--url "https://production-api.shoutaboutus.com/api/v1/campaign/template/email/list?store_id=123&template_type=regular" \
--header 'Authorization: Bearer <bearer-token>' \
--header 'Accept: application/json'Updated 11 days ago
Did this page help you?
