Preview an unpublished layout

GET

/cms/layout/{id}/preview/{preview_key}

const url = 'https://api.example.com/cms/layout/1/preview/example';
const options = {method: 'GET', headers: {'API-Key': '<API-Key>'}};

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://api.example.com/cms/layout/1/preview/example \
  --header 'API-Key: <API-Key>'

Returns an unsaved draft layout, resolved against live content. Preview keys are generated by the CMS editor and expire after 15 minutes.

Authorizations

ApiKeyAuth

Parameters

Path Parameters

required

integer

preview_key

required

string

Responses

200

Resolved draft layout

application/json

PageLayout

A published page builder layout, resolved for rendering: rows → columns → blocks on a 12-column grid. Linked presets are already inlined and list blocks carry their content in data. Render each block by its type and variant; unknown variants should fall back to the block’s default variant (see GET /cms/pagebuilder/blocks).

object

Layout ID

integer format: int64

name

Layout name

string

key

Stable key set in the editor (GET /cms/layout/key/{key}); null when not set

string

nullable

kind

What the layout is for

string

Allowed values: front landing category_template article_template author_template keyword_template

versionId

Published version ID (0 for previews of unpublished drafts)

integer format: int64

direction

Text direction of the layout: the layout’s own setting, else the site default (Page Builder settings). Columns flow in this direction. Sites entirely in one direction can ignore it; mixed-language sites should set dir on the layout’s wrapper.

string

Allowed values: ltr rtl

schemaVersion

Version of the layout document format

integer

rows

Rows, top to bottom

Array<object>

PageLayoutRow

A row of a page builder layout

object

Row ID, unique within the layout

string

settings

Row presentation settings

object

background

Background style; absent = default

string

Allowed values: muted dark brand

fullWidth

Span the full viewport width

boolean

marginTop

Space above the row, as a size of the frontend’s spacing scale; absent = frontend default

string

Allowed values: none xs sm md lg xl

marginBottom

Space below the row; absent = frontend default

string

Allowed values: none xs sm md lg xl

paddingTop

Space inside the row (within its background), at the top; absent = frontend default

string

Allowed values: none xs sm md lg xl

paddingBottom

Space inside the row, at the bottom; absent = frontend default

string

Allowed values: none xs sm md lg xl

marginStart

Space before the row on the inline-start side (left in LTR, right in RTL: margin-inline-start); absent = frontend default

string

Allowed values: none xs sm md lg xl

marginEnd

Space on the inline-end side (margin-inline-end); absent = frontend default

string

Allowed values: none xs sm md lg xl

paddingStart

Space inside the row on the inline-start side (padding-inline-start); absent = frontend default

string

Allowed values: none xs sm md lg xl

paddingEnd

Space inside the row on the inline-end side (padding-inline-end); absent = frontend default

string

Allowed values: none xs sm md lg xl

visibility

PageLayoutVisibility

Whether a row, column or block is shown on each breakpoint. Hidden items are still sent; render them hidden at that breakpoint (e.g. with CSS) so one cached response serves every device.

object

Desktop

boolean

Tablet

boolean

Mobile

boolean

presetId

Set when the row comes from a linked preset (already inlined)

integer format: int64

nullable

columns

Columns, in source order (see order for per-breakpoint reordering)

Array<object>

PageLayoutColumn

A column of a row, on a 12-column grid

object

Column ID, unique within the layout

string

span

Width out of 12 for each breakpoint, already resolved (mobile-first inheritance: unset widths are filled in)

object

Desktop

integer

>= 1 <= 12

Tablet

integer

>= 1 <= 12

Mobile

integer

>= 1 <= 12

order

Display order within the row per breakpoint (like CSS order); only breakpoints that reorder are present

object

integer

visibility

PageLayoutVisibility

Whether a row, column or block is shown on each breakpoint. Hidden items are still sent; render them hidden at that breakpoint (e.g. with CSS) so one cached response serves every device.

object

Desktop

boolean

Tablet

boolean

Mobile

boolean

blocks

Blocks, top to bottom

Array<object>

PageLayoutBlock

A block of a page builder layout. Block types: content_list, tabs, rich_text, image, embed, cta, ad_slot, newsletter_signup, social_links, messaging_zone, html, page_header, poll, form, custom, and on article templates article_body, author_box, article_tags, comments (see GET /cms/pagebuilder/blocks for the ones enabled on this deployment and their settings). A block whose type is disabled or not allowed on this layout is sent as {id, type, disabled: true} only and should not be rendered.

object

Block ID, unique within the layout. Blocks inlined from a preset get IDs prefixed with the referencing ID (e.g. r2/b1).

string

type

Block type

string

disabled

Only present (true) when the block must not be rendered: its type is disabled or not allowed on this layout. Other fields are then omitted.

boolean

nullable

variant

Desktop display variant (same as responsive.lg.variant)

string

variantOptions

Desktop variant options (same as responsive.lg.variantOptions)

object

key

additional properties

any

settings

One of:

content_list

Block settings; depends on type. variant, variantOptions and limit are not repeated here (see responsive).

object

source

object

kind

external: items are provided by the frontend (see stream)

string

Allowed values: section query mostread mostcommented external

stream

Kind=external: name of the list the frontend provides, e.g. “main”

string

section

Kind=section: dynamic section name of the page

string

pageId

Kind=section: page owning the section, when not the page being rendered

integer

filter

Kind=query: content filter (same format as a page section’s “Configure filter”)

object

key

additional properties

any

publication

Kind=mostread|mostcommented

integer

timeframe

Kind=mostread

string

header

object

title

Section heading, e.g. “Opinion”

string

link

“More” link

object

type

string

Allowed values: url category page

value

One of:

string
integer

string

offset

Items of the source skipped before this block (already applied to data)

integer

dedupe

Whether items shown higher on the page were skipped (already applied to data)

boolean

key

additional properties

any

ad_slot

Block settings; depends on type. variant, variantOptions and limit are not repeated here (see responsive).

object

slot

Ad unit / slot name known to the frontend

string

sizes

Sizes per breakpoint in Google Publisher Tag format: [width, height] pairs and/or "fluid". A breakpoint without sizes uses the next larger one’s; no sizes at all: the frontend’s defaults for the unit

object

key

additional properties

Array

key

additional properties

any

newsletter_signup

Block settings; depends on type. variant, variantOptions and limit are not repeated here (see responsive).

object

channelId

Subscribe with POST /cms/channel/{channelId}/subscribe

integer

title

string

description

string

buttonLabel

string

key

additional properties

any

social_links

Block settings; depends on type. variant, variantOptions and limit are not repeated here (see responsive).

object

title

string

links

Array<object>

object

network

string

Allowed values: facebook instagram x whatsapp telegram tiktok youtube threads linkedin rss

label

string

url

string format: uri

key

additional properties

any

messaging_zone

Block settings; depends on type. variant, variantOptions and limit are not repeated here (see responsive).

object

zoneKey

Render <div data-wb-zone-key="{zoneKey}"></div>; the messaging script fills it

string

key

additional properties

any

html

Block settings; depends on type. variant, variantOptions and limit are not repeated here (see responsive).

object

html

Raw HTML to insert as-is (may contain scripts)

string

key

additional properties

any

tabs

No settings; the tabs are in children

object

key

additional properties

any

rich_text

Render data.html (rendered like an article body), not settings.html (editor markup)

object

html

Editor markup

string

key

additional properties

any

image

Block settings; depends on type. variant, variantOptions and limit are not repeated here (see responsive).

object

attachmentId

integer

alt

string

caption

string

credit

string

link

Http(s) URL, site path or mailto

string

newTab

boolean

key

additional properties

any

embed

Block settings; depends on type. variant, variantOptions and limit are not repeated here (see responsive).

object

source

Article embed shortcode body, e.g. “embed source=youtube id=XYZ”

string

url

What the editor pasted

string

key

additional properties

any

cta

Block settings; depends on type. variant, variantOptions and limit are not repeated here (see responsive).

object

title

string

text

string

buttonLabel

string

url

Http(s) URL, site path or mailto

string

newTab

boolean

key

additional properties

any

page_header

No settings: render the title of the category, publication, author or keyword the template shows (by layout.kind); what to show is in variantOptions

object

key

additional properties

any

poll

Block settings; depends on type. variant, variantOptions and limit are not repeated here (see responsive).

object

source

object

kind

string

Allowed values: poll section

pollId

Kind=poll: the poll

integer

section

Kind=section: linkables section whose first poll is shown

string

pageId

Kind=section: page owning the section, when not the page being rendered

integer

key

additional properties

any

form

Block settings; depends on type. variant, variantOptions and limit are not repeated here (see responsive).

object

formId

integer

key

additional properties

any

custom

No settings: the component is the variant, its fields are in variantOptions (images and content resolved in optionData). Render nothing for an unknown variant

object

key

additional properties

any

responsive

Display per breakpoint (desktop-first: tablet inherits desktop, mobile inherits tablet, unless changed in the editor)

object

PageLayoutBlockDisplay

How a block is displayed at one breakpoint, after desktop-first inheritance and fallbacks are applied

object

variant

Display variant key, as configured in Page Builder settings

string

variantOptions

Presentation options of the variant (fields are defined per variant in GET /cms/pagebuilder/blocks)

object

key

additional properties

any

limit

Number of items to show at this breakpoint (list blocks); slice data to this length

integer

PageLayoutBlockDisplay

How a block is displayed at one breakpoint, after desktop-first inheritance and fallbacks are applied

object

variant

Display variant key, as configured in Page Builder settings

string

variantOptions

Presentation options of the variant (fields are defined per variant in GET /cms/pagebuilder/blocks)

object

key

additional properties

any

limit

Number of items to show at this breakpoint (list blocks); slice data to this length

integer

PageLayoutBlockDisplay

How a block is displayed at one breakpoint, after desktop-first inheritance and fallbacks are applied

object

variant

Display variant key, as configured in Page Builder settings

string

variantOptions

Presentation options of the variant (fields are defined per variant in GET /cms/pagebuilder/blocks)

object

key

additional properties

any

limit

Number of items to show at this breakpoint (list blocks); slice data to this length

integer

visibility

PageLayoutVisibility

Whether a row, column or block is shown on each breakpoint. Hidden items are still sent; render them hidden at that breakpoint (e.g. with CSS) so one cached response serves every device.

object

Desktop

boolean

Tablet

boolean

Mobile

boolean

presetId

Set when the block comes from a linked preset (already inlined)

integer format: int64

nullable

stream

External list blocks only (settings.source.kind: "external"): the slice of the named list to show, instead of data. Show items offset … offset + responsive[bp].limit - 1 of the list (0-based); items is offset + the largest limit.

object

name

string

offset

integer

items

integer

optionData

Images and content picked in image / content display options (variantOptions hold their IDs), keyed by ID across every breakpoint. Missing IDs were deleted or unpublished. Only present when such options are filled in.

object

images

object

key

additional properties

Attachment

API representation of an attachment (images, video, files)

object

Attachment ID

integer format: int64

name

Name

string

nullable

description

Description

string

nullable

type

Type (image|video|file)

string

url

Public URL

string

nullable

width

Width in pixels

integer format: int32

height

Height in pixels

integer format: int32

focal

Focal point as “x% y%”

string

nullable

transforms

Transforms (list of available image transforms)

Array<object>

object

Width in pixels

integer format: int32

Height in pixels

integer format: int32

url

URL of the transformed image

string

urls

Additional urls per transform

object

url_medium

Search title

string

url_highres

Search description

string

url_original

Social title

string

video

One of:

Video

Video

API representation of a video

object

Video ID

integer format: int64

title

Title

string

url

URL

string

duration

Duration in seconds

integer format: int64

number

Episode number

integer format: int64

nullable

status

Status

string

showId

Show ID

integer format: int64

nullable

showName

Show name

string

nullable

showUrl

Show URL

string

nullable

brief

Brief

string

nullable

thumbnail

Thumbnail URL

string

nullable

thumbnailPlay

ThumbnailPlay URL

string

nullable

filename

Filename/URL

string

nullable

publishDate

Publish date

string

nullable

views

Views

integer format: int64

publish

Publish flag

nullable

formats

Formats

Array<object>

nullable

Video_Format

API representation of a video format

object

format

Format

string

filename

Filename/URL

string

cdnPath

CDN path

string

nullable

mime

MIME type

string

duration

Duration in seconds

integer format: int32

nullable

content

object

key

additional properties

Content

API representation of an article/content item (v3)

object

objectType

Object PHP class name

string

Article ID

integer format: int64

signature

Signature

string

nullable

url

Absolute URL

string

nullable

shorturl

Short URL

string

nullable

slug

Slug

string

nullable

contentType

ContentType

API representation of a content type

object

Content Type ID

name

Name

string

slug

Slug

string

editor

Editor

string

Allowed values: default email html tiptap

views

Views count

integer

comments

Comments count

integer

rating

Average rating by customers

number format: float

rating_count

Total ratings count

number format: integer

preview_limit

Preview limit

integer

excludedFromGoogleSearchEngine

Excluded from search engine flag

integer

title

Title

string

nullable

firstPublished

First published date

string format: date-time

nullable

lastUpdate

Last update date

string format: date-time

nullable

categories

Example

{
  "id": 12,
  "name": "Homepage",
  "key": "category-template",
  "kind": "front",
  "versionId": 57,
  "direction": "ltr",
  "schemaVersion": 1,
  "rows": [
    {
      "id": "r1",
      "settings": {
        "background": "muted"
      },
      "visibility": {
        "lg": true,
        "md": true,
        "xs": false
      },
      "presetId": 7,
      "columns": [
        {
          "id": "c1",
          "span": {
            "lg": 8,
            "md": 8,
            "xs": 12
          },
          "order": {
            "xs": 2
          },
          "visibility": {
            "lg": true,
            "md": true,
            "xs": false
          },
          "blocks": [
            {
              "id": "b1",
              "type": "content_list",
              "variant": "lead_grid",
              "variantOptions": {
                "leadBadge": "TOP STORY",
                "showByline": false
              },
              "settings": {
                "source": {
                  "kind": "section",
                  "section": "top_stories"
                },
                "header": {
                  "title": "Top stories",
                  "link": {
                    "type": "category",
                    "value": 12
                  }
                },
                "dedupe": true
              },
              "responsive": {
                "lg": {
                  "variant": "lead_grid",
                  "variantOptions": {
                    "leadBadge": "TOP STORY",
                    "showByline": false
                  },
                  "limit": 7
                },
                "md": {
                  "variant": "lead_grid",
                  "variantOptions": {
                    "leadBadge": "TOP STORY",
                    "showByline": false
                  },
                  "limit": 7
                },
                "xs": {
                  "variant": "compact_byline",
                  "variantOptions": [],
                  "limit": 4
                }
              },
              "visibility": {
                "lg": true,
                "md": true,
                "xs": true
              },
              "limit": 7,
              "data": [
                {
                  "id": 101,
                  "title": "Example story"
                }
              ]
            }
          ]
        }
      ]
    }
  ],
  "streams": {
    "main": {
      "items": 20
    }
  }
}

404

Invalid or expired preview key