---
title: "getDesign"
method: GET
path: "/v1/designs/{designId}"
tags: ["design-builder"]
---

# getDesign

`GET /v1/designs/{designId}`

Search for a especific design owned by user organization

## Path parameters

- `designId` string, required — Id of the design

## Response `200`

Success - design loaded with success.

- GetDesignRes
  - `design` object
    - `id` string
    - `created_at` string — Creation date and time
    - `created_by` string
    - `edited` boolean, required
    - `last_modified_at` string
    - `brand_id` string
    - `brand_name` string
    - `user` object
      - `emailaddress` string
      - `fullname` string
      - `name` string
      - `userid` string
    - `style_name` string, required
    - `style` object, required
      - `logo` LogoData
        - `main` FileData
          - `name` string, required
          - `display_name` string
          - `file_type` 'LOGO' | 'FONT' | 'IMAGE'
          - `s3_object_key` string, required
          - `url` string, required
          - `file_id` string — ID of the source file entity in the epilot file-entity system. Set when the file was picked from the File Manager (rather than uploaded directly to the design-builder bucket). Consumers resolve the live `public_url` via this reference. The org id is derived from the journey's owning org at render time (same convention as journey image blocks), so blueprint cross-org installs work without any extra remapping.
      - `palette` PaletteData, required
        - `primary` string, required
        - `secondary` string, required
        - `error` string, required
        - `background` string, required
        - `paper` string, required
        - `navbar` string, required
        - `portal_login_background` string
      - `typography` TypographyData, required
        - `font` FontData, required
          - `font_id` string, required
          - `font_name` string, required
          - `font_family` string
          - `font_weight_regular` string
          - `font_weight_medium` string
          - `font_weight_bold` string
          - `urls` FontResponseUrl[], required
            - `type` 'WOFF2' | 'WOFF' | 'TTF' | 'EOT'
            - `url` string
        - `primary` string, required
        - `secondary` string, required
      - `shape` ShapeData
        - `border_radius` number
      - `consumer` ConsumerData, required
        - `widgets` WidgetData[], required
          - `id` string, required
          - `name` string, required
        - `customer_portals` CustomerPortalData[], required
          - `id` string, required
          - `name` string, required
    - `is_default` boolean
    - `_manifest` string[] — The manifest IDs associated with this design
    - `custom_theme` string
    - `use_custom_theme` boolean
    - `design_tokens` object — Design tokens for journey customization
      - `coupon` string
      - `cashback` string
      - `custom_css` string
      - `accent_color` string — Accent color, defaults to primary
      - `outline_color` string — Global outline/focus color
      - `divider_color` string — Divider line color
      - `link_color` string — Link text color
      - `link_hover_color` string — Link hover text color
      - `font_size_scale` 'xs' | 'sm' | 'md' | 'lg' | 'xl' — Font size scale factor
      - `topbar_height` number — Topbar minimum height in pixels
      - `topbar_logo_alignment` 'flex-start' | 'center' | 'flex-end' — Logo/content alignment in the top bar
      - `logo_size` number — Logo size in pixels
      - `input_background` string — Input field background color
      - `input_border_color` string — Input field border color
      - `input_text_color` string — Input field text color
      - `input_label_color` string — Input field label color
      - `input_border_radius` number — Input field border radius in pixels
      - `input_height` number — Input field height in pixels
      - `input_variant` 'outlined' | 'filled' | 'underlined' — Input field variant style
      - `button_primary_bg` string — Primary button background color or gradient
      - `button_primary_text` string — Primary button text color
      - `button_primary_hover_bg` string — Primary button hover background color or gradient
      - `button_primary_hover_text` string — Primary button hover text color
      - `button_outlined_border` string — Outlined button border color
      - `button_outlined_text` string — Outlined button text color
      - `button_outlined_hover_bg` string — Outlined button hover background color
      - `button_outlined_hover_text` string — Outlined button hover text color
      - `button_ghost_bg` string — Ghost button background color
      - `button_ghost_text` string — Ghost button text color
      - `button_ghost_hover_bg` string — Ghost button hover background color
      - `button_ghost_hover_text` string — Ghost button hover text color
      - `button_border_radius` number — Button border radius in pixels
      - `button_height` number — Button height in pixels
      - `card_background` string — Card background color
      - `card_border_color` string — Card border color for outlined variant
      - `card_variant` 'shadow' | 'outlined' — Card visual variant
      - `summary_card_background` string — Summary card background color
      - `toggle_selected_bg` string — Toggle button selected background color
      - `toggle_selected_text` string — Toggle button selected text color
      - `toggle_hover_bg` string — Toggle button hover background color
      - `toggle_hover_text` string — Toggle button hover text color
      - `toggle_border_color` string — Toggle group wrapper border color
      - `dropdown_hover_bg` string — Dropdown option hover background color
      - `dropdown_hover_text` string — Dropdown option hover text color
      - `dropdown_selected_bg` string — Dropdown option selected background color
      - `dropdown_selected_text` string — Dropdown option selected text color
      - `switch_unchecked_color` string — Switch unchecked thumb color
      - `switch_unchecked_bg` string — Switch unchecked track background color
      - `switch_border_radius` number — Switch border radius in pixels
      - `checkbox_unchecked_color` string — Checkbox unchecked border color
      - `checkbox_label_color` string — Checkbox label text color
      - `radio_unchecked_color` string — Radio button unchecked border color
      - `radio_label_color` string — Radio button label text color
      - `datepicker_selected_bg` string — Date picker selected date background color
      - `datepicker_selected_color` string — Date picker selected date text color
      - `datepicker_border_radius` number — Date picker border radius in pixels
      - `chip_background` string — Chip background color
      - `chip_hover_background` string — Chip hover background color
      - `chip_text_color` string — Chip text color
      - `chip_hover_text_color` string — Chip hover text color

## Other responses

- `400` — Validation Errors
- `401` — Authentication Errors
- `404` — No design found
- `500` — Other errors

---

[API](https://skmtc.net/epilot/apis/design-builder-api-v2.md) · [All operations](https://skmtc.net/epilot/apis/design-builder-api-v2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/epilot/design-builder-api-v2/versions/220aa4fb07e9/schema)
