Skip to content
Documentation

List Email Design Systems

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

Retrieves the email design systems for the currently logged in user.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
workspace_id
required
integer

Workspace ID

Query Parameters

Section titled “Query Parameters ”
per
integer
default: 10

Number of records per page

page
integer
default: 1

Page number

archived
string
Allowed values: true false all

Filter projects by archive status:

  • false (default): Only return non-archived projects
  • true: Only return archived projects
  • all: Return both archived and non-archived projects
include_shared
string
default: true
Allowed values: true false
Example
true

Whether to include email design systems shared from other workspaces

sort
string
Allowed values: created_at_asc created_at_desc updated_at_asc updated_at_desc name_asc name_desc

Sorting

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful

object
results
required
Array<object>
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
pagination
required
object
per
required
integer
Example
10
page
required
integer
Example
1
total
required
integer
Example
100