---
title: "GET /v1/workspaces/{workspaceId}/starters"
method: GET
path: "/v1/workspaces/{workspaceId}/starters"
---

# GET /v1/workspaces/{workspaceId}/starters

`GET /v1/workspaces/{workspaceId}/starters`

## Request

- Base URL: `https://api.bangermail.com`
- URL: `https://api.bangermail.com/v1/workspaces/{workspaceId}/starters`
- Auth: HTTP bearer

Starter layouts rendered in the product brand, each with a brief (job, when to send, metric, mechanic, subject lines to test), slots and default content. Listings are compact and default to the product's kind of business; request one starter by id for its body_html.

## Query parameters

- `id` string
- `business` 'all' | 'saas' | 'shop' | 'creator' | 'services' | 'local' | 'community'
- `stage` 'onboarding' | 'activation' | 'revenue' | 'retention' | 'publish' | 'account'
- `category` 'product' | 'lifecycle' | 'broadcast'
- `include_html` boolean
- `style` 'brand' | 'clarity' | 'editorial' | 'luxe' | 'material' | 'playful' | 'bold' | 'plain'
- `locale` string

## Response `200`

Successful response.

- object
  - `data` EmailStarter[], required
    - `id` string, required
    - `version` integer, required
    - `category` string, required
    - `message_kind` string, required
    - `family` string, required
    - `stage` string, required
    - `businesses` string[], required
    - `name` string, required
    - `description` string, required
    - `subject` string, required
    - `body_text` string, required
    - `brief` object, required
      - `job` string, required
      - `send_when` string, required
      - `metric` string, required
      - `mechanic` string, required
      - `subject_variants` string[], required
      - `keep` string[]
      - `avoid` string[]
      - `imagery` object
        - `default` string, required
        - `slot` string
        - `photo_idea` string
    - `slots` TemplateSlot[], required
      - `key` string, required
      - `label` string
      - `type` 'text' | 'paragraph' | 'url' | 'image'
      - `help` string
    - `content` object, required
    - `body_html` string
  - `business` string, required
  - `style` string, required
  - `businesses` object[], required
    - `key` string
    - `label` string
    - `hint` string
  - `stages` object[], required
    - `key` string
    - `label` string
  - `styles` object[], required
    - `key` string, required
    - `label` string, required
    - `description` string, required

## Other responses

- `404`: No starter has that id.

---

[API](https://skmtc.dev/bangermail/apis/banger-api.md) · [All operations](https://skmtc.dev/bangermail/apis/banger-api/llms.txt) · [OpenAPI document](https://skmtc.dev/bangermail/apis/banger-api/revisions/0705eb6ef2bc?raw)