Skip to content

Get Email Design System

GET
/api/v1/workspaces/{workspace_id}/email_design_systems/{id}

Retrieves an email design system.

workspace_id
required
integer

Workspace ID

id
required
integer

Email Design System ID

Successful

object
id
required
integer
Example
12345
name
required
string
Example
My Email Design System
description
string
Example
My Email Design System
created_at
required
string format: date-time
Example
2023-08-23T10:30:00.000Z
updated_at
string format: date-time
Example
2023-08-23T10:30:00.000Z
organization_id
required
integer
Example
12345
workspace_id
required
integer
Example
12345
screenshot_url
required
string
Example
https://www.example.com/screenshot.png
upload_status
required
string
Allowed values: ready processing
Example
success
create_with_ai
required
boolean
require_brand_profile_for_use
required
boolean
prompt
required
string
nullable
Example
I want an email design system with a header, a footer, and a content section.
ai_generation_status
required
string
nullable
Allowed values: generating done
Example
generating
archived
required
boolean
design_tokens
required
object
key
additional properties
any
Example
{
"primary_button_color": "#007bff",
"secondary_button_color": "#6c757d"
}
access_scope
required
string
Allowed values: all_workspaces this_workspace_only
Example
all_workspaces
custom_styles
required
Array<object>
object
style
required
string
Example
background-color: yellow; font-weight: bold;
name
required
string
Example
highlight
label
required
string
Example
Highlight