List email types

Overview

See every kind of email we can send and whether each is on.

Use this to find the type you want to customize.

You'll need the company_id of the account whose templates you want.

Returns one entry per type with its status. Types managed centrally by the platform aren't listed.

Prerequisites

A bearer token. See Authentication.
The account's id (company_id), with the email templates section turned on.

Base URL

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

Endpoint

POST /api/v1/account/white-label/email-templates/list

Authentication

Partner or Account token

company_id must be inside your own account tree. A Partner token can use any account under the partner; an Account token only its own account.
A missing company_id, or one outside your tree, returns 403 (You do not have access to this company.), not 422.
The email templates section must be turned on for the account's partner (email_templates_enabled in Get branding). When it's off, every email template call for that account returns 403 with The email template section is disabled for this account.

Rate limit

This endpoint has no rate limit.

Request parameters

None.

Request body

Field	Type	Required	Description
`company_id`	integer	Yes	The account. Must be inside your account tree; missing or outside it returns `403`.

Request payload

{
  "company_id": 5994
}

Response body

The payload is inside data.

Field	Type	Description
`status`	string	`success`.
`data`	array of objects	One entry per email type.
`data[].type`	string	The email type. Use it as `type` in the other email template calls.
`data[].label`	string	The type's name.
`data[].group`	string	Group it belongs to: `User`, `Location` or `Account`.
`data[].audience`	string	Who receives it: `user`, `location` or `account`.
`data[].is_critical`	boolean	Whether it is a critical transactional email.
`data[].is_platform_owned`	boolean	Whether it is managed centrally by the platform; `false` for every type listed here.
`data[].is_report`	boolean	Whether it is a scheduled report email.
`data[].supports_webhook`	boolean	Whether it can be delivered to your webhook (see Choose who sends an email).
`data[].is_enabled`	boolean	Whether it's sent. Your setting, else the default for the account.
`data[].show_logo`	boolean	Whether the logo is shown. Your setting, else `true`.
`data[].delivery_method`	string	`direct` (we send it) or `webhook`. Your setting, else `direct`.
`data[].customized`	boolean	Whether you have saved your own content or subject for it.
`data[].default_subject`	string	The default subject, with merge fields.
`data[].updated_at`	string or null	When you last changed its settings or content; `null` if never.

Response payload

{
  "data": {
    "status": "success",
    "data": [
      {
        "type": "verify_email",
        "label": "Email Verification",
        "group": "User",
        "audience": "user",
        "is_critical": true,
        "is_platform_owned": false,
        "is_report": false,
        "supports_webhook": true,
        "is_enabled": true,
        "show_logo": true,
        "delivery_method": "direct",
        "customized": false,
        "default_subject": "Please verify your email address.",
        "updated_at": null
      },
      {
        "type": "user_welcome",
        "label": "User Welcome",
        "group": "User",
        "audience": "user",
        "is_critical": true,
        "is_platform_owned": false,
        "is_report": false,
        "supports_webhook": true,
        "is_enabled": true,
        "show_logo": true,
        "delivery_method": "direct",
        "customized": true,
        "default_subject": "Welcome to [partnerTitle]",
        "updated_at": "2026-06-20T14:31:05.000000Z"
      },
      {
        "type": "review_response_reply",
        "label": "Review Response Reply",
        "group": "Location",
        "audience": "location",
        "is_critical": false,
        "is_platform_owned": false,
        "is_report": false,
        "supports_webhook": false,
        "is_enabled": true,
        "show_logo": true,
        "delivery_method": "direct",
        "customized": false,
        "default_subject": "A reply to your review for [storeName]",
        "updated_at": null
      },
      {
        "type": "report_activity",
        "label": "Report: Activity",
        "group": "Account",
        "audience": "account",
        "is_critical": false,
        "is_platform_owned": false,
        "is_report": true,
        "supports_webhook": false,
        "is_enabled": true,
        "show_logo": true,
        "delivery_method": "direct",
        "customized": false,
        "default_subject": "Activity Report",
        "updated_at": null
      }
    ]
  }
}

Examples

Success payload

See Response payload.

Error payload

403 company_id missing or outside your tree

{
  "message": "You do not have access to this company.",
  "status": "error",
  "errors": []
}

403 Email templates section is off

{
  "message": "The email template section is disabled for this account.",
  "status": "error",
  "errors": []
}

Status	Meaning
`200`	The email types.
`401`	The token is missing, expired or invalid.
`403`	`company_id` is missing or outside your account tree (this endpoint returns `403`, not `422`, for both), or the email templates section is off for this account.
`500`	Unexpected server error.

Example request

curl --request POST \
  --url "https://production-api.shoutaboutus.com/api/v1/account/white-label/email-templates/list" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"company_id": 5994}'