Skip to content
Documentation

List Email Design Systems

GET
/api/v1/workspaces/{workspace_id}/email_design_systems
curl --request GET \
  --url 'https://example.com/%7B%7Bapp_url%7D/api/v1/workspaces/1/email_design_systems?per=10&page=1&archived=true&include_shared=true&sort=created_at_asc' \
  --header 'Authorization: Bearer <token>'

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

Authorizations

Section titled “Authorizations”
  • OAuth2
    email_design_systems:read

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
Example
false

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

Media typeapplication/json
object
results
required
Array<object>
object
id
required
integer
name
required
string
description
string
created_at
required
string format: date-time
updated_at
string format: date-time
organization_id
required
integer
workspace_id
required
integer
screenshot_url
required
string
upload_status
required
string
Allowed values: ready processing
require_brand_profile_for_use
required
boolean
archived
required
boolean
design_tokens
required
object
key
additional properties
any
access_scope
required
string
Allowed values: all_workspaces this_workspace_only
custom_styles
required
Array<object>
object
style
required
string
name
required
string
label
required
string
pagination
required
object
per
required
integer
page
required
integer
total
required
integer
Example
{
  "results": [
    {
      "id": 12345,
      "name": "My Email Design System",
      "description": "My Email Design System",
      "created_at": "2023-08-23T10:30:00.000Z",
      "updated_at": "2023-08-23T10:30:00.000Z",
      "organization_id": 12345,
      "workspace_id": 12345,
      "screenshot_url": "https://www.example.com/screenshot.png",
      "upload_status": "ready",
      "require_brand_profile_for_use": false,
      "archived": false,
      "design_tokens": {
        "primary_button_color": "#007bff",
        "secondary_button_color": "#6c757d"
      },
      "access_scope": "all_workspaces",
      "custom_styles": [
        {
          "style": "background-color: yellow; font-weight: bold;",
          "name": "highlight",
          "label": "Highlight"
        }
      ]
    }
  ],
  "pagination": {
    "per": 10,
    "page": 1,
    "total": 100
  }
}