Get Email Design System

GET

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

const url = 'https://example.com/%7B%7Bapp_url%7D/api/v1/workspaces/1/email_design_systems/1';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/%7B%7Bapp_url%7D/api/v1/workspaces/1/email_design_systems/1 \
  --header 'Authorization: Bearer <token>'

Retrieves an email design system.

Authorizations

OAuth2
email_design_systems:read

Parameters

Path Parameters

workspace_id

required

integer

Workspace ID

required

integer

Email Design System ID

Responses

200

Successful

application/json

object

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

Example

{
  "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"
    }
  ]
}