List Layouts

GET

/api/v1/workspaces/{workspace_id}/layouts

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

Retrieves the layouts.

Authorizations

OAuth2
layouts:read

Parameters

Path Parameters

workspace_id

required

integer

Workspace ID

Query Parameters

email_design_system_id

integer

Email Design System ID

brand_profile_id

integer | string

>= 1 /^(null|[1-9][0-9]*)$/

Brand Profile ID, or the literal string “null” to return only layouts without a brand profile.

Example

per

integer

default: 10

Number of records per page

page

integer

default: 1

Page number

sort

string

Allowed values: created_at_asc created_at_desc updated_at_asc updated_at_desc name_asc name_desc

Sorting

Responses

200

Successful

application/json

object

results

required

Array<object>

object

required

integer

name

required

string

content

required

object

container_component_instance

required

object

required

string format: uuid

name

string

component_name

required

The name of the component definition this instance is based on.

string

conditional_id

The ID of a saved conditional applied to this component instance. When set, inline_conditional must not be set. The component renders a separate variant for each branch of the conditional.

integer | null

inline_conditional

One of:

object
null

A conditional definition owned by a single component instance in an email.

object

default_syntax

required

object

closing

required

The closing syntax tag for the conditional block.

string

branch_values

Key-value pairs where the key is the branch key and the value is the opening syntax for that branch.

object

key

additional properties

string

branches

required

Array<object>

object

key

required

string

label

required

string

dynamic_content_profile_syntaxes

required

object

key

additional properties

A per-DynamicContentProfile syntax entry on a Conditional.

object

closing

The closing syntax tag for the conditional block.

string

branch_values

Key-value pairs where the key is the branch key and the value is the opening syntax for that branch.

object

key

additional properties

string

field_values

Field values organized by branch key.

object

key

additional properties

Field values organized by locale code.

object

key

additional properties

Field values keyed by liquid variable name.

object

key

additional properties

object

value

required

One of:

string

link_tracking_parameters

Link tracking parameter values specific to this field.

object

key

additional properties

string

hidden_from_locales

A map of locale codes to boolean values indicating whether this component instance is hidden for that locale.

object

key

additional properties

boolean

link_tracking_parameters

object

branch_content

Per-component-instance link tracking parameter values, organized by branch key, then by locale code.

object

key

additional properties

object

key

additional properties

A map of link tracking parameter names to their values for this component instance.

object

key

additional properties

string

component_instances

required

Array<object>

object

required

string format: uuid

name

string

component_name

required

The name of the component definition this instance is based on.

string

conditional_id

The ID of a saved conditional applied to this component instance. When set, inline_conditional must not be set. The component renders a separate variant for each branch of the conditional.

integer | null

inline_conditional

One of:

object
null

A conditional definition owned by a single component instance in an email.

object

default_syntax

required

object

closing

required

The closing syntax tag for the conditional block.

string

branch_values

Key-value pairs where the key is the branch key and the value is the opening syntax for that branch.

object

key

additional properties

string

branches

required

Array<object>

object

key

required

string

label

required

string

dynamic_content_profile_syntaxes

required

object

key

additional properties

A per-DynamicContentProfile syntax entry on a Conditional.

object

closing

The closing syntax tag for the conditional block.

string

branch_values

Key-value pairs where the key is the branch key and the value is the opening syntax for that branch.

object

key

additional properties

string

field_values

Field values organized by branch key.

object

key

additional properties

Field values organized by locale code.

object

key

additional properties

Field values keyed by liquid variable name.

object

key

additional properties

object

value

required

One of:

string

link_tracking_parameters

Link tracking parameter values specific to this field.

object

key

additional properties

string

hidden_from_locales

A map of locale codes to boolean values indicating whether this component instance is hidden for that locale.

object

key

additional properties

boolean

link_tracking_parameters

object

branch_content

Per-component-instance link tracking parameter values, organized by branch key, then by locale code.

object

key

additional properties

object

key

additional properties

A map of link tracking parameter names to their values for this component instance.

object

key

additional properties

string

email_design_system_id

required

integer

brand_profile_id

required

integer | null

locales

required

Array<string>

created_at

required

string format: date-time

updated_at

required

string format: date-time

pagination

required

object

per

required

integer

page

required

integer

total

required

integer

Example

{
  "results": [
    {
      "id": 12345,
      "name": "Admin",
      "content": {
        "container_component_instance": {
          "id": "bd1c1b82-1a7b-4f0f-b079-30c1d4189bed",
          "name": "My Component",
          "component_name": "Headline",
          "conditional_id": 1,
          "inline_conditional": {
            "default_syntax": {
              "closing": "{% endif %}",
              "branch_values": {
                "gold_membership": "{% if membership == 'gold' %}",
                "silver_membership": "{% elsif membership == 'silver' %}"
              }
            },
            "branches": [
              {
                "key": "gold_membership",
                "label": "Gold Membership"
              }
            ],
            "dynamic_content_profile_syntaxes": {
              "additionalProperty": {
                "closing": "{% endif %}",
                "branch_values": {
                  "gold_membership": "{% if membership == 'gold' %}",
                  "silver_membership": "{% elsif membership == 'silver' %}"
                }
              }
            }
          },
          "hidden_from_locales": {
            "additionalProperty": true
          }
        },
        "component_instances": [
          {
            "id": "bd1c1b82-1a7b-4f0f-b079-30c1d4189bed",
            "name": "My Component",
            "component_name": "Headline",
            "conditional_id": 1,
            "inline_conditional": {
              "default_syntax": {
                "closing": "{% endif %}",
                "branch_values": {
                  "gold_membership": "{% if membership == 'gold' %}",
                  "silver_membership": "{% elsif membership == 'silver' %}"
                }
              },
              "branches": [
                {
                  "key": "gold_membership",
                  "label": "Gold Membership"
                }
              ],
              "dynamic_content_profile_syntaxes": {
                "additionalProperty": {
                  "closing": "{% endif %}",
                  "branch_values": {
                    "gold_membership": "{% if membership == 'gold' %}",
                    "silver_membership": "{% elsif membership == 'silver' %}"
                  }
                }
              }
            },
            "hidden_from_locales": {
              "additionalProperty": true
            }
          }
        ]
      },
      "email_design_system_id": 12345,
      "brand_profile_id": 12345,
      "locales": [
        "en-GB"
      ],
      "created_at": "2023-08-23T10:30:00.000Z",
      "updated_at": "2023-08-23T10:30:00.000Z"
    }
  ],
  "pagination": {
    "per": 10,
    "page": 1,
    "total": 100
  }
}

401

Unauthorized

application/json

object

message

required

string

code

string

Example

{
  "message": "Record not found",
  "code": "share_link_expired"
}

403

Forbidden

application/json

object

message

required

string

code

string

Example

{
  "message": "Record not found",
  "code": "share_link_expired"
}

404

Not Found

application/json

object

message

required

string

code

string

Example

{
  "message": "Record not found",
  "code": "share_link_expired"
}