Get Component Versions

GET

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

const url = 'https://example.com/%7B%7Bapp_url%7D/api/v1/workspaces/1/email_design_systems/1/components/example/versions?per=10&page=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/components/example/versions?per=10&page=1' \
  --header 'Authorization: Bearer <token>'

Retrieves the versions of a component.

Authorizations

OAuth2
email_design_systems:read

Parameters

Path Parameters

workspace_id

required

integer

Workspace ID

name

required

string

Component name

emailDesignSystemId

required

integer

Email Design System ID

Query Parameters

per

integer

default: 10

Number of records per page

page

integer

default: 1

Page number

Responses

200

Successful

application/json

object

results

required

Array<object>

object

version_id

required

string

component_data

required

object

name

required

string

label

required

string

template

required

string

field_definitions

required

Array

One of:

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

liquid_variable

required

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

string

visible_if

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

string

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

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

created_at

required

string format: date-time

last_updated_by

required

object

One of:

object
object

object

type

required

string

Allowed values: User

required

integer

first_name

required

string

last_name

required

string

profile_image_url

required

string

nullable

pagination

required

object

per

required

integer

page

required

integer

total

required

integer

Example

{
  "results": [
    {
      "component_data": {
        "name": "MyComponent",
        "label": "My Component",
        "template": "<div>My Component</div>",
        "field_definitions": [
          {
            "type": "text",
            "group": "Styling",
            "liquid_variable": "heading_text",
            "visible_if": "show_heading == true",
            "hint": "Keep this short and punchy"
          }
        ]
      },
      "created_at": "2023-08-23T10:30:00.000Z",
      "last_updated_by": {
        "type": "User",
        "id": 12345,
        "first_name": "John",
        "last_name": "Smith",
        "profile_image_url": "https://example.com/profile.jpg"
      }
    }
  ],
  "pagination": {
    "per": 10,
    "page": 1,
    "total": 100
  }
}

401

Unauthorized

application/json

object

message

required

string

Example

{
  "message": "Record not found"
}

403

Forbidden

application/json

object

message

required

string

Example

{
  "message": "Record not found"
}

404

Not Found

application/json

object

message

required

string

Example

{
  "message": "Record not found"
}