Get Email Design System

GET

api

email-design-system

curl --request GET \
  --url https://api.sequenzy.com/api/v1/email-design-system \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.sequenzy.com/api/v1/email-design-system', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sequenzy.com/api/v1/email-design-system",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sequenzy.com/api/v1/email-design-system"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/email-design-system")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "designSystem": {
    "version": 1,
    "designCode": {
      "version": 1,
      "kickerStyle": "letterspaced",
      "titleAlignment": "center",
      "buttonShape": "pill",
      "dividerStyle": "line",
      "density": "airy",
      "openerTreatments": ["editorial-masthead", "hero-color"]
    },
    "compositionSpine": "editorial",
    "source": "derived"
  },
  "directionText": null,
  "isDefault": true
}

{"success": false, "error": {"code": "UNAUTHORIZED", "message": "Invalid API key"}}

{"success": false, "error": {"code": "NOT_FOUND", "message": "Company not found"}}

Get the company’s effective email design system - the locked visual grammar (kicker style, title alignment, button shape, divider style, density, sanctioned opener treatments) and the composition spine that anchors how AI-generated emails and sequence steps are structured. The identity is stored as the company’s emailDesignPrompt design direction text: tokens are parsed from that text, and any token the text does not state is derived deterministically from brand context. While the text is empty or untouched, isDefault is true. Adjust tokens with Update Email Design System, or edit the text as free prose via PATCH /companies/:companyId.

Request

curl "https://api.sequenzy.com/api/v1/email-design-system" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response fields

string

How eyebrows above titles render: chip (soft badge chips), letterspaced (uppercase letter-spaced text), or none.

string

left or center alignment for headings and hero content.

string

rounded rectangles or fully rounded pill buttons.

string

line (thin dividers between sections) or space (whitespace only).

string

airy (generous spacing) or compact (tight sections).

string[]

The opener treatments this company’s emails may use, primary first. Values: hero-image, hero-color, header-hero, editorial-masthead, title-led.

string

Which worked-example skeleton anchors generation: hero-led (designed marketing sections), editorial (typography-first), or product-spec (information-dense).

string

derived when every token comes from brand derivation; custom when the direction text carries the identity.

string | null

The raw design direction text the tokens were parsed from; null when the company has none yet.

boolean

True while the identity is purely derived from brand context.

Responses

{
  "success": true,
  "designSystem": {
    "version": 1,
    "designCode": {
      "version": 1,
      "kickerStyle": "letterspaced",
      "titleAlignment": "center",
      "buttonShape": "pill",
      "dividerStyle": "line",
      "density": "airy",
      "openerTreatments": ["editorial-masthead", "hero-color"]
    },
    "compositionSpine": "editorial",
    "source": "derived"
  },
  "directionText": null,
  "isDefault": true
}

{"success": false, "error": {"code": "UNAUTHORIZED", "message": "Invalid API key"}}

{"success": false, "error": {"code": "NOT_FOUND", "message": "Company not found"}}

Get Email Design System

curl --request GET \
  --url https://api.sequenzy.com/api/v1/email-design-system \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.sequenzy.com/api/v1/email-design-system', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sequenzy.com/api/v1/email-design-system",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sequenzy.com/api/v1/email-design-system"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/email-design-system")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "designSystem": {
    "version": 1,
    "designCode": {
      "version": 1,
      "kickerStyle": "letterspaced",
      "titleAlignment": "center",
      "buttonShape": "pill",
      "dividerStyle": "line",
      "density": "airy",
      "openerTreatments": ["editorial-masthead", "hero-color"]
    },
    "compositionSpine": "editorial",
    "source": "derived"
  },
  "directionText": null,
  "isDefault": true
}

{"success": false, "error": {"code": "UNAUTHORIZED", "message": "Invalid API key"}}

{"success": false, "error": {"code": "NOT_FOUND", "message": "Company not found"}}

​Request

​Response fields

​Responses

Request

Response fields

Responses