Get Layout
const url = 'https://example.com/%7B%7Bapp_url%7D/api/v1/workspaces/1/layouts/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/layouts/1 \ --header 'Authorization: Bearer <token>'Retrieves a layout.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Workspace ID
Layout ID
Responses
Section titled “Responses”Successful
object
object
object
The name of the component definition this instance is based on.
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.
A conditional definition owned by a single component instance in an email.
object
object
The closing syntax tag for the conditional block.
Key-value pairs where the key is the branch key and the value is the opening syntax for that branch.
object
object
object
A per-DynamicContentProfile syntax entry on a Conditional. Either a manually-authored {closing, branch_values} pair or a picker-authored {uses_ui_picker, ui_picker_state} pair — the two modes are mutually exclusive.
object
Manual mode only. The closing syntax tag for the conditional block.
Manual mode only. Key-value pairs where the key is the branch key and the value is the opening syntax for that branch.
object
When true, the syntax for this dynamic content profile was authored via the UI picker for the profile’s template engine preset. When false or absent, it was defined manually.
State authored via the conditional UI picker. Rendered on read (by the template engine preset) into a {closing, branch_values} syntax.
object
When true, the final branch of the parent Conditional is rendered as an else branch and its key is omitted from branches below.
Picker state keyed by branch key. Includes one entry per non-else branch; when include_else_branch is true the final branch key is omitted.
object
Picker-authored state for a single non-else branch of a conditional.
object
How multiple conditions combine (e.g. “and”, “or”). Always present for a stable shape; only semantically meaningful when conditions has more than one entry. Must be one of the joiners allowed by the preset — see template_engine_preset_schema.joiners.
Conditions that must all (or any, depending on joiner) hold for this branch to match. At least one entry required.
A single condition within a picker branch. Validated server-side against the profile’s template engine preset capabilities.
object
The reference the template engine reads when evaluating this condition (e.g. “profile.tier”).
Declared value type. Drives the allowed operators and the shape of value.
One of the operators the preset allows for the declared type. See template_engine_preset_schema.operators_by_type[type] on the associated DynamicContentProfile.
The value being compared against. Always a string on the wire; the preset renderer decides how to format it based on type (quoted for “string”, raw for “number”/“boolean”). Required when the operator’s definition has requires_value=true; null (or absent) when requires_value=false.
Field values organized by branch key.
object
Field values organized by locale code.
A map of locale codes to boolean values indicating whether this component instance is hidden for that locale.
object
object
Per-component-instance link tracking parameter values, organized by branch key, then by locale code.
object
object
A map of link tracking parameter names to their values for this component instance.
object
object
The name of the component definition this instance is based on.
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.
A conditional definition owned by a single component instance in an email.
object
object
The closing syntax tag for the conditional block.
Key-value pairs where the key is the branch key and the value is the opening syntax for that branch.
object
object
object
A per-DynamicContentProfile syntax entry on a Conditional. Either a manually-authored {closing, branch_values} pair or a picker-authored {uses_ui_picker, ui_picker_state} pair — the two modes are mutually exclusive.
object
Manual mode only. The closing syntax tag for the conditional block.
Manual mode only. Key-value pairs where the key is the branch key and the value is the opening syntax for that branch.
object
When true, the syntax for this dynamic content profile was authored via the UI picker for the profile’s template engine preset. When false or absent, it was defined manually.
State authored via the conditional UI picker. Rendered on read (by the template engine preset) into a {closing, branch_values} syntax.
object
When true, the final branch of the parent Conditional is rendered as an else branch and its key is omitted from branches below.
Picker state keyed by branch key. Includes one entry per non-else branch; when include_else_branch is true the final branch key is omitted.
object
Picker-authored state for a single non-else branch of a conditional.
object
How multiple conditions combine (e.g. “and”, “or”). Always present for a stable shape; only semantically meaningful when conditions has more than one entry. Must be one of the joiners allowed by the preset — see template_engine_preset_schema.joiners.
Conditions that must all (or any, depending on joiner) hold for this branch to match. At least one entry required.
A single condition within a picker branch. Validated server-side against the profile’s template engine preset capabilities.
object
The reference the template engine reads when evaluating this condition (e.g. “profile.tier”).
Declared value type. Drives the allowed operators and the shape of value.
One of the operators the preset allows for the declared type. See template_engine_preset_schema.operators_by_type[type] on the associated DynamicContentProfile.
The value being compared against. Always a string on the wire; the preset renderer decides how to format it based on type (quoted for “string”, raw for “number”/“boolean”). Required when the operator’s definition has requires_value=true; null (or absent) when requires_value=false.
Field values organized by branch key.
object
Field values organized by locale code.
A map of locale codes to boolean values indicating whether this component instance is hidden for that locale.
object
object
Per-component-instance link tracking parameter values, organized by branch key, then by locale code.
object
object
A map of link tracking parameter names to their values for this component instance.
object
Example
{ "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' %}" }, "uses_ui_picker": false, "ui_picker_state": { "include_else_branch": false, "branches": { "gold": { "joiner": "and", "conditions": [ { "field": "profile.tier", "type": "string", "operator": "equals", "value": "gold" } ] } } } } } }, "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' %}" }, "uses_ui_picker": false, "ui_picker_state": { "include_else_branch": false, "branches": { "gold": { "joiner": "and", "conditions": [ { "field": "profile.tier", "type": "string", "operator": "equals", "value": "gold" } ] } } } } } }, "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"}Unauthorized
object
Example
{ "message": "Record not found"}Forbidden
object
Example
{ "message": "Record not found"}Not Found
object
Example
{ "message": "Record not found"}