---
title: "List email references"
method: GET
path: "/references"
tags: ["References"]
---

# List email references

`GET /references`

## Request

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

Lists real emails (and, for sequences, whole sequences) from the Sequenzy email gallery to model a new email on, for the kind of email you are creating. By default they come from the gallery brands most like you, ranked by how close their businesses (what each sells, and to whom) are in meaning to your company description, closest first (rankings are reused for up to 10 minutes; a description change counts at once). Each `url` works with the from-example endpoints. Always empty when the gallery is not available. Requires `templates:read`.

## Query parameters

- `kind` 'campaign' | 'sequence' | 'transactional', required
- `scope` 'similar' | 'all'
- `q` string
- `page` integer
- `subtype` string
- `limit` integer

## Response `200`

References

- object
  - `success` boolean
  - `kind` 'campaign' | 'sequence' | 'transactional'
  - `scope` 'similar' | 'all'
  - `page` integer
  - `pageCount` integer
  - `profile` 'ready' | 'missing': `missing` when your company has neither a description nor company context to find brands like you; `scope=similar` is then empty. Always `ready` for `scope=all`.
  - `brands` object[]: With `scope=similar`, the gallery brands most like you, closest first. Empty for `scope=all`.
    - `name` string
    - `domain` string
    - `slug` string
    - `url` string
  - `emails` object[]
    - `id` string
    - `subject` string, nullable
    - `preheader` string, nullable
    - `type` string, nullable
    - `subtype` string, nullable
    - `sentAt` string, date-time
    - `analysis` GalleryEmailAnalysis, nullable: The email's breakdown, `null` until it has been analyzed. Counts come from its HTML; `voice`, `language`, `structure` and `takeaways` from AI reading the copy. Any field is `null` (or an empty list) when unknown.
      - `mainButton` string, nullable: Label of the first button, the primary call to action.
      - `buttonLabels` string[]: Button labels in reading order, up to 5.
      - `buttonCount` integer, nullable
      - `linkCount` integer, nullable: Links of any kind, buttons included.
      - `wordCount` integer, nullable
      - `readingTimeSeconds` integer, nullable
      - `imageCount` integer, nullable: Content images; icons and spacers are left out.
      - `hasGif` boolean, nullable
      - `darkMode` boolean, nullable: Whether the email ships custom `prefers-color-scheme` dark styles.
      - `fonts` string[]: Most used font families, up to 3.
      - `columns` 'single' | 'multi' | 'null', nullable
      - `format` 'plain' | 'text_heavy' | 'balanced' | 'visual' | 'null', nullable
      - `voice` 'friendly' | 'professional' | 'playful' | 'urgent' | 'inspirational' | 'informative' | 'personal' | 'null', nullable
      - `language` string, nullable: BCP 47 language code, such as `en`.
      - `structure` string[]: The email's beats in order, such as "Logo header" and "Primary button".
      - `takeaways` string[]: Why the email works, as observations about its choices. Never performance claims.
      - `sender` object, nullable: The sender as shown on gallery pages, with personal details redacted. `null` when unknown.
        - `name` string, nullable
        - `address` string, nullable
    - `brand` object
      - `name` string
      - `domain` string
      - `slug` string
    - `url` string
  - `sequences` object[]: For `kind=sequence` on the first page only.
    - `id` string
    - `name` string
    - `emailCount` integer
    - `brand` object
      - `name` string
      - `domain` string
      - `slug` string
    - `url` string

## Other responses

- `401`: Unauthorized
- `403`: API key lacks `templates:read`
- `422`: The request body or parameters are invalid
- `503`: Your company description could not be compared with gallery brands right now (`REFERENCES_UNAVAILABLE`). Retry shortly, or use `scope=all`.

## Changes

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

[Operation history](https://skmtc.dev/sequenzy/apis/sequenzy-api/changes/references/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/8156dc12d8b4?raw)