Get Component

GET

/api/v1/workspaces/{workspace_id}/email_design_systems/{emailDesignSystemId}/components/{name}

Retrieves a component.

Authorizations

• BearerAuth

Parameters

Path Parameters

workspace_id

required

integer

Workspace ID

name

required

string

Component name

emailDesignSystemId

required

integer

Email Design System ID

Responses

200

Successful

object

name

required

string

Example

MyComponent

label

required

string

Example

My Component

description

required

string

nullable

Example

A hero banner image with a headline and image, body text and a call to action button.

email_design_system_id

required

integer

Example

12345

updated_at

required

string format: date-time

Example

2023-08-23T10:30:00.000Z

created_at

required

string format: date-time

Example

2023-08-23T10:30:00.000Z

container

boolean

nullable

template

required

string

Example

<div>My Component</div>

field_definitions

required

Array

One of:

object

object

type

required

string

Allowed values: text

label

required

string

group

An optional label used to group related fields together in the editor.

string

nullable

Example

Styling

liquid_variable

required

The Liquid variable name used to reference this field in templates.

string

Example

heading_text

visible_if

A Liquid expression (without the surrounding {% %}) that determines when this field is visible in the editor.

string

Example

show_heading == true

default_value

required

string

validations

object

min_length

integer

max_length

integer

must_not_be_blank

boolean

must_not_be_default

boolean

hint

Helper text displayed below the field in the editor.

string

Example

Keep this short and punchy

hidden_in_editor

Whether this field is hidden from the editor UI.

boolean

hidden_from_ai

Whether this field is hidden from AI Agents.

boolean

feed_field_name

The name of the feed field that populates this field’s value. If null, this field is not populated from a feed.

string

nullable

object

object

type

required

string

Allowed values: number

label

required

string

group

An optional label used to group related fields together in the editor.

string

nullable

Example

Styling

liquid_variable

required

The Liquid variable name used to reference this field in templates.

string

Example

heading_text

visible_if

A Liquid expression (without the surrounding {% %}) that determines when this field is visible in the editor.

string

Example

show_heading == true

default_value

required

number

validations

object

min

number

max

number

hint

Helper text displayed below the field in the editor.

string

Example

Keep this short and punchy

hidden_in_editor

Whether this field is hidden from the editor UI.

boolean

hidden_from_ai

Whether this field is hidden from AI Agents.

boolean

feed_field_name

The name of the feed field that populates this field’s value. If null, this field is not populated from a feed.

string

nullable

object

object

type

required

string

Allowed values: enum

label

required

string

group

An optional label used to group related fields together in the editor.

string

nullable

Example

Styling

liquid_variable

required

The Liquid variable name used to reference this field in templates.

string

Example

heading_text

visible_if

A Liquid expression (without the surrounding {% %}) that determines when this field is visible in the editor.

string

Example

show_heading == true

default_value

required

string

validations

object

options

required

Array<object>

object

label

required

string

value

required

string

hint

Helper text displayed below the field in the editor.

string

Example

Keep this short and punchy

hidden_in_editor

Whether this field is hidden from the editor UI.

boolean

hidden_from_ai

Whether this field is hidden from AI Agents.

boolean

feed_field_name

The name of the feed field that populates this field’s value. If null, this field is not populated from a feed.

string

nullable

object

object

type

required

string

Allowed values: boolean

label

required

string

group

An optional label used to group related fields together in the editor.

string

nullable

Example

Styling

liquid_variable

required

The Liquid variable name used to reference this field in templates.

string

Example

heading_text

visible_if

A Liquid expression (without the surrounding {% %}) that determines when this field is visible in the editor.

string

Example

show_heading == true

default_value

required

boolean

validations

object

hint

Helper text displayed below the field in the editor.

string

Example

Keep this short and punchy

hidden_in_editor

Whether this field is hidden from the editor UI.

boolean

hidden_from_ai

Whether this field is hidden from AI Agents.

boolean

feed_field_name

The name of the feed field that populates this field’s value. If null, this field is not populated from a feed.

string

nullable

object

object

type

required

string

Allowed values: url

label

required

string

group

An optional label used to group related fields together in the editor.

string

nullable

Example

Styling

liquid_variable

required

The Liquid variable name used to reference this field in templates.

string

Example

heading_text

visible_if

A Liquid expression (without the surrounding {% %}) that determines when this field is visible in the editor.

string

Example

show_heading == true

default_value

required

string

validations

object

must_not_be_blank

boolean

must_not_be_default

boolean

hint

Helper text displayed below the field in the editor.

string

Example

Keep this short and punchy

hidden_in_editor

Whether this field is hidden from the editor UI.

boolean

hidden_from_ai

Whether this field is hidden from AI Agents.

boolean

feed_field_name

The name of the feed field that populates this field’s value. If null, this field is not populated from a feed.

string

nullable

skip_link_tracking

Whether to skip link tracking for URLs in this field.

boolean

nullable

object

object

type

required

string

Allowed values: image

label

required

string

group

An optional label used to group related fields together in the editor.

string

nullable

Example

Styling

liquid_variable

required

The Liquid variable name used to reference this field in templates.

string

Example

heading_text

visible_if

A Liquid expression (without the surrounding {% %}) that determines when this field is visible in the editor.

string

Example

show_heading == true

default_value

required

string

validations

object

must_not_be_blank

boolean

must_not_be_default

boolean

hint

Helper text displayed below the field in the editor.

string

Example

Keep this short and punchy

hidden_in_editor

Whether this field is hidden from the editor UI.

boolean

hidden_from_ai

Whether this field is hidden from AI Agents.

boolean

feed_field_name

The name of the feed field that populates this field’s value. If null, this field is not populated from a feed.

string

nullable

object

object

type

required

string

Allowed values: color

label

required

string

group

An optional label used to group related fields together in the editor.

string

nullable

Example

Styling

liquid_variable

required

The Liquid variable name used to reference this field in templates.

string

Example

heading_text

visible_if

A Liquid expression (without the surrounding {% %}) that determines when this field is visible in the editor.

string

Example

show_heading == true

default_value

required

string

validations

object

hint

Helper text displayed below the field in the editor.

string

Example

Keep this short and punchy

hidden_in_editor

Whether this field is hidden from the editor UI.

boolean

hidden_from_ai

Whether this field is hidden from AI Agents.

boolean

feed_field_name

The name of the feed field that populates this field’s value. If null, this field is not populated from a feed.

string

nullable

object

object

type

required

string

Allowed values: rich_text

label

required

string

group

An optional label used to group related fields together in the editor.

string

nullable

Example

Styling

liquid_variable

required

The Liquid variable name used to reference this field in templates.

string

Example

heading_text

visible_if

A Liquid expression (without the surrounding {% %}) that determines when this field is visible in the editor.

string

Example

show_heading == true

default_value

required

string

validations

object

max_content_length

integer

min_content_length

integer

must_not_be_blank

boolean

must_not_be_default

boolean

hint

Helper text displayed below the field in the editor.

string

Example

Keep this short and punchy

hidden_in_editor

Whether this field is hidden from the editor UI.

boolean

hidden_from_ai

Whether this field is hidden from AI Agents.

boolean

feed_field_name

The name of the feed field that populates this field’s value. If null, this field is not populated from a feed.

string

nullable

marks

required

object

bold

required

object

enabled

required

boolean

custom_style_name

string

nullable

italic

required

object

enabled

required

boolean

custom_style_name

string

nullable

link

required

object

enabled

required

boolean

custom_style_name

string

nullable

bullet_list

required

object

enabled

required

boolean

custom_style_name

string

nullable

numbered_list

required

object

enabled

required

boolean

custom_style_name

string

nullable

Example

{
  "bold": {
    "enabled": true
  },
  "italic": {
    "enabled": true
  },
  "link": {
    "enabled": true
  },
  "bullet_list": {
    "enabled": true
  },
  "numbered_list": {
    "enabled": true
  }
}

custom_styles_names

Names of custom rich text styles available for this field.

Array<string>

nullable

object

object

type

required

string

Allowed values: code

label

required

string

group

An optional label used to group related fields together in the editor.

string

nullable

Example

Styling

liquid_variable

required

The Liquid variable name used to reference this field in templates.

string

Example

heading_text

visible_if

A Liquid expression (without the surrounding {% %}) that determines when this field is visible in the editor.

string

Example

show_heading == true

default_value

required

string

validations

object

must_not_be_blank

boolean

must_not_be_default

boolean

hint

Helper text displayed below the field in the editor.

string

Example

Keep this short and punchy

hidden_in_editor

Whether this field is hidden from the editor UI.

boolean

hidden_from_ai

Whether this field is hidden from AI Agents.

boolean

feed_field_name

The name of the feed field that populates this field’s value. If null, this field is not populated from a feed.

string

nullable

object

object

type

required

string

Allowed values: horizontal_align

label

required

string

group

An optional label used to group related fields together in the editor.

string

nullable

Example

Styling

liquid_variable

required

The Liquid variable name used to reference this field in templates.

string

Example

heading_text

visible_if

A Liquid expression (without the surrounding {% %}) that determines when this field is visible in the editor.

string

Example

show_heading == true

default_value

required

string

validations

object

options

required

Array<string>

Allowed values: left center right

hint

Helper text displayed below the field in the editor.

string

Example

Keep this short and punchy

hidden_in_editor

Whether this field is hidden from the editor UI.

boolean

hidden_from_ai

Whether this field is hidden from AI Agents.

boolean

feed_field_name

The name of the feed field that populates this field’s value. If null, this field is not populated from a feed.

string

nullable

object

object

type

required

string

Allowed values: vertical_align

label

required

string

group

An optional label used to group related fields together in the editor.

string

nullable

Example

Styling

liquid_variable

required

The Liquid variable name used to reference this field in templates.

string

Example

heading_text

visible_if

A Liquid expression (without the surrounding {% %}) that determines when this field is visible in the editor.

string

Example

show_heading == true

default_value

required

string

validations

object

options

required

Array<string>

Allowed values: top middle bottom

hint

Helper text displayed below the field in the editor.

string

Example

Keep this short and punchy

hidden_in_editor

Whether this field is hidden from the editor UI.

boolean

hidden_from_ai

Whether this field is hidden from AI Agents.

boolean

feed_field_name

The name of the feed field that populates this field’s value. If null, this field is not populated from a feed.

string

nullable

screenshot_url

required

string

Example

https://www.example.com/screenshot.png

position

required

integer

nullable

Example

1

last_updated_by

required

object

id

required

integer

Example

12345

first_name

required

string

Example

John

last_name

required

string

Example

Smith

profile_image_url

required

string

nullable

Example

https://example.com/profile.jpg

feed_id

required

integer

nullable

Example

12345

deprecated

required

boolean

401

Unauthorized

object

message

required

string

Example

Record not found

403

Forbidden

object

message

required

string

Example

Record not found

404

Not Found

object

message

required

string

Example

Record not found