---
title: "Get design.md"
method: GET
path: "/design-md"
tags: ["design.md"]
---

# Get design.md

`GET /design-md`

## Request

- Base URL: `https://api.sequenzy.com/api/v1`
- URL: `https://api.sequenzy.com/api/v1/design-md`
- Auth: HTTP bearer

Returns the company's design.md, its email design brief as one Markdown document. YAML frontmatter holds the exact values AI-generated emails use (logo, colors, fonts, buttons, cornerRadius, layout tokens), shown as the values emails actually get. The body holds the Voice and Design direction sections the AI writer follows, plus a read-only Reference email section naming the saved AI style. design.md is a view over existing company fields, not a separate store.

## Response `200`

design.md returned

- object
  - `success` boolean
  - `markdown` string: The full design.md document.
  - `version` string: Content version. Pass it as expectedVersion when saving so a concurrent change fails instead of being overwritten.
  - `designSystem` EmailDesignSystem: The visual identity every AI-generated email renders inside, parsed from the company's design direction text.
    - `version` integer, required
    - `designCode` object, required: The locked visual grammar applied to every generated email.
      - `version` integer, required
      - `kickerStyle` 'chip' | 'letterspaced' | 'none', required
      - `titleAlignment` 'left' | 'center', required
      - `buttonShape` 'rounded' | 'pill', required
      - `dividerStyle` 'line' | 'space', required
      - `density` 'airy' | 'compact', required
      - `openerTreatments` string[], required
    - `compositionSpine` 'hero-led' | 'editorial' | 'product-spec', required: Which worked-example skeleton anchors email composition.
    - `source` 'derived' | 'custom', required: derived when every token comes from brand derivation; custom when the direction text carries the identity.

## Other responses

- `401`: Unauthorized
- `403`: The API key lacks account:read, or the caller cannot access the company
- `404`: Company not found
- `503`: The database was temporarily unavailable. The request may be retried after the delay in Retry-After.

## Changes

- **2026-10-16** `db3873ca3d4d`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/sequenzy/apis/sequenzy-api/changes/design-md/get.md)

---

[API](https://skmtc.dev/sequenzy/apis/sequenzy-api.md) - [All operations](https://skmtc.dev/sequenzy/apis/sequenzy-api/llms.txt) - [OpenAPI document](https://skmtc.dev/sequenzy/apis/sequenzy-api/revisions/3d816357b738?raw)