Skip to main content
GET
/
v2
/
{workspace}
/
template
/
{template_slug}
/
channel
/
{channel}
/
variant
/
{variant_id}
Get Variant
curl -X GET "https://management-api.suprsend.com/v2/{workspace}/template/{template_slug}/channel/{channel}/variant/{variant_id}/" \
  --header 'Authorization: ServiceToken <token>'
{
  "$schema": "https://schema.suprsend.com/template/v2/variant_schema.json",
  "channel": "email",
  "id": "default",
  "tenant_id": null,
  "locale": "en",
  "conditions": [],
  "hash": "dd176370a4b99c735e30f70bc98c61983671072c40db70750c3ada9e5edcabc1",
  "needs_vendor_approval": false,
  "sysgen_template_name": null,
  "approval_status": "auto_approved",
  "discard_comment": null,
  "approval_at": "2026-04-07T10:39:28.502737Z",
  "content": {
    "$schema": "https://schema.suprsend.com/template/v2/channel/email_schema.json",
    "templating_language": "handlebars",
    "from_name": "Acme Store",
    "from_address": "noreply@acme-store.com",
    "extra_to": "",
    "cc": "",
    "bcc": "",
    "reply_to": "",
    "subject": "Order Confirmed - #{{order.number}}",
    "body": {
      "type": "raw",
      "raw": {
        "html": "<html><body><h1>Order Confirmed!</h1><p>Hi {{customer.name}}, your order #{{order.number}} has been confirmed.</p><p>Total: {{order.total}}</p></body></html>",
        "text": "Hi {{customer.name}}, your order #{{order.number}} has been confirmed. Total: {{order.total}}"
      },
      "designer": {
        "html": "...",
        "text": "...",
        "design_json": {},
        "display_conditions": []
      },
      "preheader": "Your order #{{order.number}} is confirmed",
      "plain_text": null,
      "email_markup": ""
    }
  },
  "errors": {},
  "vendor_approvals": [],
  "has_error": false,
  "seq_no": 1,
  "action": null,
  "created_at": "2026-04-07T10:39:28.510000Z"
}

Authorizations

ServiceToken <token>
string
header
required

You can get Service Token from SuprSend dashboard -> Account Settings -> Service Tokens section.

Path Parameters

workspace
string
required
template_slug
string
required
channel
enum<string>
required
Available options:
email,
sms,
whatsapp,
inbox,
androidpush,
iospush,
webpush,
slack,
ms_teams
variant_id
string
required

Variant identifier.

Response

Variant details retrieved. Includes full content and vendor_approvals objects.

$schema
string

Schema URL for variant validation.

Example:

"https://schema.suprsend.com/template/v2/variant_schema.json"

channel
string

Channel this variant belongs to.

Example:

"email"

id
string

Variant identifier.

Example:

"default"

tenant_id
string | null

Tenant this variant is scoped to, or null for default.

locale
string

Locale code.

Example:

"en"

conditions
object[]

Conditions for variant selection at send time.

hash
string

Content hash for change detection.

needs_vendor_approval
boolean

Whether this variant requires vendor approval (SMS DLT, WhatsApp).

sysgen_template_name
string | null

System-generated template name for vendor approval.

approval_status
enum<string>

Current approval status of the variant.

Available options:
auto_approved,
pending,
sent_for_approval,
approved,
rejected
discard_comment
string | null

Reason provided when a variant is discarded.

approval_at
string<date-time> | null

Timestamp when the variant was approved.

has_error
boolean

Whether the variant has validation errors.

seq_no
integer

Ordering within the channel + tenant + locale combination.

action
string | null

Action taken in the latest commit (Updated, Added, Unchanged, or null).

created_at
string<date-time>

Timestamp when the variant was created.

content
object

Channel-specific content. Structure varies by channel. Only returned in variant detail endpoint.

vendor_approvals
object[]

Vendor approval entries (WhatsApp/SMS only). Only returned in variant detail endpoint.