Skip to content
WhiteBeard

Get a resolved layout by key

GET
/cms/layout/key/{key}

Same as GET /cms/layout/{id}, addressed by the layout’s stable key (set in the editor’s Layout settings, e.g. category-template). Prefer this to numeric IDs, which differ between environments. Typical use: templates whose lists are provided by the frontend (streams), and standalone layouts such as a shared sidebar.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
key
required
string
/^[a-z0-9][a-z0-9_-]{0,63}$/
Example
category-template

Query Parameters

Section titled “Query Parameters”
include_text
string
Allowed values: 1 2

Include full text in content. ‘1’ complete text, ‘2’ introduction and summary only

Responses

Section titled “Responses”

200

Section titled “200”

Resolved layout

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
id

Layout ID

integer format: int64
Example
12
name

Layout name

string
Example
Homepage
key

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

string
nullable
Example
category-template
kind

What the layout is for

string
Allowed values: front landing category_template article_template author_template keyword_template
Example
front
versionId

Published version ID (0 for previews of unpublished drafts)

integer format: int64
Example
57
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
Example
rtl
schemaVersion

Version of the layout document format

integer
Example
1
rows

Rows, top to bottom

Array<object>
PageLayoutRow

A row of a page builder layout

object
id

Row ID, unique within the layout

string
Example
r1
settings

Row presentation settings

object
background

Background style; absent = default

string
Allowed values: muted dark brand
fullWidth

Span the full viewport width

boolean
Example
{
  "background": "muted"
}
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
lg

Desktop

boolean
md

Tablet

boolean
xs

Mobile

boolean
Example
{
  "lg": true,
  "md": true,
  "xs": false
}
presetId

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

integer format: int64
nullable
Example
7
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
id

Column ID, unique within the layout

string
Example
c1
span

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

object
lg

Desktop

integer
>= 1 <= 12
md

Tablet

integer
>= 1 <= 12
xs

Mobile

integer
>= 1 <= 12
Example
{
  "lg": 8,
  "md": 8,
  "xs": 12
}
order

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

object
lg
integer
md
integer
xs
integer
Example
{
  "xs": 2
}
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
lg

Desktop

boolean
md

Tablet

boolean
xs

Mobile

boolean
Example
{
  "lg": true,
  "md": true,
  "xs": false
}
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 (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
id

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

string
Example
b1
type

Block type

string
Example
content_list
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
Example
lead_grid
variantOptions

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

object
key
additional properties
any
settings
One of:
content_list
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
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
responsive

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

object
lg
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
Example
compact_byline
variantOptions

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

object
key
additional properties
any
Example
{
  "showByline": true
}
limit

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

integer
Example
4
md
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
Example
compact_byline
variantOptions

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

object
key
additional properties
any
Example
{
  "showByline": true
}
limit

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

integer
Example
4
xs
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
Example
compact_byline
variantOptions

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

object
key
additional properties
any
Example
{
  "showByline": true
}
limit

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

integer
Example
4
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
lg

Desktop

boolean
md

Tablet

boolean
xs

Mobile

boolean
Example
{
  "lg": true,
  "md": true,
  "xs": false
}
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
Example
main
offset
integer
Example
1
items
integer
Example
6
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
id

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
x

Width in pixels

integer format: int32
y

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

API representation of a video

object
id

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
id

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
id

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

Categories

Array<object>
Category

API representation of a category

object
id

Category ID

string format: int64
layoutTemplate
One of:
PageTemplateMatch

The page builder template to render a category, publication, article, author or keyword with (the layoutTemplate field of their views). Fetch the layout with GET /cms/layout/key/{key}, or GET /cms/layout/{id} when key is null.

object
id

Layout ID of the template

integer format: int64
Example
31
key

Stable key of the template; null when not set

string
nullable
Example
opinion-article
name

Template name

string
Example
Opinion article
matchedBy

Why this template applies, most specific first: the content type (article templates only), the category itself, a parent category, or the publication; for author and keyword templates, the author or keyword itself

string
Allowed values: article_type category parent_category publication author keyword
Example
category
targetType

What the template is used for

string
Allowed values: article_type category publication author keyword
Example
category
targetId

ID of the content type, category, publication, author or keyword

integer format: int64
Example
14
name

Category name

string
seo_name

Seo name

string
nullable
signature

Signature

string
nullable
slug

Slug

string
nullable
typeId

Type ID or object

mixed
nullable
parentId

Parent category ID

nullable
parent

Parent object

nullable
image

Image URL

string
nullable
cover

Cover URL

string
nullable
logo

Logo URL

string
nullable
paid

Paid flag

string
nullable
objectType

PHP class name of the object

string
url

Absolute URL

string
cssCode

CSS code

string
nullable
template

Template name

string
nullable
tagline

Tagline

string
nullable
link_param

Link parameter

string
nullable
description

Description

string
nullable
metaDescription

Meta description

string
nullable
order

Order

nullable
pageId

Page ID

nullable
articlesCount

Articles count

integer
nullable
allowComments

Allow comments flag

string
nullable
accessType

Access type of the category (e.g., public, restricted)

string
nullable
status

Status

string
nullable
children
Array<object> recursive
contents
One of:

HTML string

string
content_length

Content length

integer
summary

Summary

string
nullable
introduction

Introduction

string
nullable
premium

Premium flag

nullable
free

Free flag

nullable
credits

Credits

nullable
authors

Authors

Array<object>
Author

API representation of an author

object
id

Author ID

integer format: int64
layoutTemplate
One of:
PageTemplateMatch

The page builder template to render a category, publication, article, author or keyword with (the layoutTemplate field of their views). Fetch the layout with GET /cms/layout/key/{key}, or GET /cms/layout/{id} when key is null.

object
id

Layout ID of the template

integer format: int64
Example
31
key

Stable key of the template; null when not set

string
nullable
Example
opinion-article
name

Template name

string
Example
Opinion article
matchedBy

Why this template applies, most specific first: the content type (article templates only), the category itself, a parent category, or the publication; for author and keyword templates, the author or keyword itself

string
Allowed values: article_type category parent_category publication author keyword
Example
category
targetType

What the template is used for

string
Allowed values: article_type category publication author keyword
Example
category
targetId

ID of the content type, category, publication, author or keyword

integer format: int64
Example
14
url

URL to the author page

string
name

Author name

string
image

Image URL

string
nullable
image_transforms

Available image transformations in different sizes

Array<object>
object
x

Width in pixels

integer
y

Height in pixels

integer
url

URL to the transformed image

string format: uri
cover

Cover image URL

string
nullable
email

Author email

string
nullable
department

Department

string
nullable
editorialName

Editorial name (slug)

string
nullable
biography

Short biography

string
nullable
description

Full description (HTML)

string
nullable
name_latin

Name in latin characters

string
nullable
country

Country code or name

string
nullable
googlePlus

Google+ profile (legacy)

string
nullable
twitter

Twitter handle (without @)

string
nullable
facebook

Facebook username

string
nullable
linkedin

LinkedIn profile

string
nullable
instagram

Instagram handle

string
nullable
objectType

Class name of the object

string
replacedWith

If this author was replaced, id of replacement

nullable
source

Source, if present

string
nullable
sponsor
One of:
Sponsor

API representation of a sponsor

object
id

Sponsor ID

integer format: int64
url

URL to the sponsor page

string
name

Sponsor name

string
image

Image URL

string
nullable
attachments

Attachments

Array<object>
nullable
Attachment

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

object
id

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
x

Width in pixels

integer format: int32
y

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

API representation of a video

object
id

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
inline_attachments

Inline attachments

Array<object>
nullable
Attachment

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

object
id

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
x

Width in pixels

integer format: int32
y

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

API representation of a video

object
id

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
files

Files

Array<object>
nullable
Attachment

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

object
id

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
x

Width in pixels

integer format: int32
y

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

API representation of a video

object
id

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
videos

Videos

Array<object>
nullable
Attachment

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

object
id

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
x

Width in pixels

integer format: int32
y

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

API representation of a video

object
id

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
keywords

Keywords

Array<object>
Keyword

API representation of a keyword

object
keywordId

Keyword ID

integer format: int64
layoutTemplate
One of:
PageTemplateMatch

The page builder template to render a category, publication, article, author or keyword with (the layoutTemplate field of their views). Fetch the layout with GET /cms/layout/key/{key}, or GET /cms/layout/{id} when key is null.

object
id

Layout ID of the template

integer format: int64
Example
31
key

Stable key of the template; null when not set

string
nullable
Example
opinion-article
name

Template name

string
Example
Opinion article
matchedBy

Why this template applies, most specific first: the content type (article templates only), the category itself, a parent category, or the publication; for author and keyword templates, the author or keyword itself

string
Allowed values: article_type category parent_category publication author keyword
Example
category
targetType

What the template is used for

string
Allowed values: article_type category publication author keyword
Example
category
targetId

ID of the content type, category, publication, author or keyword

integer format: int64
Example
14
name

Name

string
url

URL

string
slug

Slug

string
description

Description

string
nullable
articlesCount

Articles count

integer
replacedWith

If this keyword was replaced, id of replacement

nullable
display_name

Display name

string
nullable
translations

Translations

nullable
collection_id

Collection id

integer
nullable
image

Image URL

string
nullable
related
Array<object> recursive
elements

Elements (youtube, liveblogs, polls, quiz)

object
liveblogs

Live blogs in the article

Array<object>
nullable
LiveBlog

API representation of a liveblog

object
id

LiveBlog ID

integer format: int64
title

Title

string
start_date

Start date

string
nullable
end_date

End date

string
nullable
room_name

Websocket room name

string
preview

Preview messages

Array<object>
LiveBlogMessage

API representation of a liveblog message

object
id

Message ID

integer format: int64
timestamp

Timestamp

string
nullable
text

Text

string
nullable
title

Title

string
nullable
minute

Minute

string
nullable
minute_additional

Additional minute value

integer format: int64
typeId

Type id

string
nullable
imageLetter

Image letter/character

string
nullable
highlight

Highlight flag

boolean
html

HTML content

string
nullable
user

User display name

string
user_thumbnail

User thumbnail URL

string
nullable
polls

Polls in the article

Array<object>
nullable
Poll

API representation of a poll

object
id

Poll ID

integer format: int64
timestamp

Timestamp

string
question

Question

string
choices

Choices

Array<string>
votes

Votes

integer
slug

Slug

string
category
PollCategory

API representation of a poll category

object
id

Category ID

integer format: int64
name

Name

string
image

Image

string
results

Results

Array<object>
object
value

Number of votes

integer format: int64
percentage

Percentage of total votes

number format: float
message

Message

string
onlyLoggedIn

Only logged in

integer
endDate

End date

string
nullable
voted

Voted (only true when voting)

boolean
voted_choice

Voted choice (only valid when voting)

integer
closed

Closed

integer
quizzes

Quizzes in the article

Array<object>
nullable
Quiz

API representation of a quiz

object
id

Quiz ID

integer format: int64
name

Name

string
timestamp

Timestamp

string
image

Image

string
coverPicture

Cover picture

string
description

Description

string
share

Share

string
template

Template

string
allow_form

Allow form

string
introduction_message

Introduction message

string
thankyou_message

Thankyou message

string
terms

Terms

string
status

Status

string
questions

Questions

Array<object>
QuizQuestion

API representation of a quiz question

object
id

Question ID

integer format: int64
title

Title

string
resultText

Result text

string
image

Image

string
choices

Choices

Array<object>
QuizAnswer

API representation of a quiz answer

object
id

Answer ID

integer format: int64
answer

Answer text

string
letter

Letter

string
image

Image

string
correct

Correct

boolean
points

Points

integer
votes

Votes

integer
results

Results

Array<object>
QuizResult

API representation of a quiz result

object
id

Result ID

integer format: int64
result

Result

string
image

Image

string
letter

Letter

string
resultText

Result text

string
share

Share

string
twitterShare

Twitter share

string
minimum

Minimum

integer
maximum

Maximum

integer
votes

Votes

integer
youtube

YouTube video IDs in the article

Array<string>
nullable
seo

SEO object

object
search_title

Search title

string
search_description

Search description

string
social_title

Social title

string
social_description

Social description

string
social_image

Social image URL

string
time_to_read

Time to read (seconds)

integer
access_control

Access control enabled

boolean
access_allowed

Access allowed

boolean
status

Status

nullable
cached

Cached flag

boolean
limit

List blocks only: number of items in data (or in the stream slice), the largest limit across breakpoints

integer
nullable
Example
7
data
One of:
list items
Array
One of:
Content

API representation of an article/content item (v3)

object
objectType

Object PHP class name

string
id

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
id

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

Categories

Array<object>
Category

API representation of a category

object
id

Category ID

string format: int64
layoutTemplate
One of:
PageTemplateMatch

The page builder template to render a category, publication, article, author or keyword with (the layoutTemplate field of their views). Fetch the layout with GET /cms/layout/key/{key}, or GET /cms/layout/{id} when key is null.

object
id

Layout ID of the template

integer format: int64
Example
31
key

Stable key of the template; null when not set

string
nullable
Example
opinion-article
name

Template name

string
Example
Opinion article
matchedBy

Why this template applies, most specific first: the content type (article templates only), the category itself, a parent category, or the publication; for author and keyword templates, the author or keyword itself

string
Allowed values: article_type category parent_category publication author keyword
Example
category
targetType

What the template is used for

string
Allowed values: article_type category publication author keyword
Example
category
targetId

ID of the content type, category, publication, author or keyword

integer format: int64
Example
14
name

Category name

string
seo_name

Seo name

string
nullable
signature

Signature

string
nullable
slug

Slug

string
nullable
typeId

Type ID or object

mixed
nullable
parentId

Parent category ID

nullable
parent

Parent object

nullable
image

Image URL

string
nullable
cover

Cover URL

string
nullable
logo

Logo URL

string
nullable
paid

Paid flag

string
nullable
objectType

PHP class name of the object

string
url

Absolute URL

string
cssCode

CSS code

string
nullable
template

Template name

string
nullable
tagline

Tagline

string
nullable
link_param

Link parameter

string
nullable
description

Description

string
nullable
metaDescription

Meta description

string
nullable
order

Order

nullable
pageId

Page ID

nullable
articlesCount

Articles count

integer
nullable
allowComments

Allow comments flag

string
nullable
accessType

Access type of the category (e.g., public, restricted)

string
nullable
status

Status

string
nullable
children
Array<object> recursive
contents
One of:

HTML string

string
content_length

Content length

integer
summary

Summary

string
nullable
introduction

Introduction

string
nullable
premium

Premium flag

nullable
free

Free flag

nullable
credits

Credits

nullable
authors

Authors

Array<object>
Author

API representation of an author

object
id

Author ID

integer format: int64
layoutTemplate
One of:
PageTemplateMatch

The page builder template to render a category, publication, article, author or keyword with (the layoutTemplate field of their views). Fetch the layout with GET /cms/layout/key/{key}, or GET /cms/layout/{id} when key is null.

object
id

Layout ID of the template

integer format: int64
Example
31
key

Stable key of the template; null when not set

string
nullable
Example
opinion-article
name

Template name

string
Example
Opinion article
matchedBy

Why this template applies, most specific first: the content type (article templates only), the category itself, a parent category, or the publication; for author and keyword templates, the author or keyword itself

string
Allowed values: article_type category parent_category publication author keyword
Example
category
targetType

What the template is used for

string
Allowed values: article_type category publication author keyword
Example
category
targetId

ID of the content type, category, publication, author or keyword

integer format: int64
Example
14
url

URL to the author page

string
name

Author name

string
image

Image URL

string
nullable
image_transforms

Available image transformations in different sizes

Array<object>
object
x

Width in pixels

integer
y

Height in pixels

integer
url

URL to the transformed image

string format: uri
cover

Cover image URL

string
nullable
email

Author email

string
nullable
department

Department

string
nullable
editorialName

Editorial name (slug)

string
nullable
biography

Short biography

string
nullable
description

Full description (HTML)

string
nullable
name_latin

Name in latin characters

string
nullable
country

Country code or name

string
nullable
googlePlus

Google+ profile (legacy)

string
nullable
twitter

Twitter handle (without @)

string
nullable
facebook

Facebook username

string
nullable
linkedin

LinkedIn profile

string
nullable
instagram

Instagram handle

string
nullable
objectType

Class name of the object

string
replacedWith

If this author was replaced, id of replacement

nullable
source

Source, if present

string
nullable
sponsor
One of:
Sponsor

API representation of a sponsor

object
id

Sponsor ID

integer format: int64
url

URL to the sponsor page

string
name

Sponsor name

string
image

Image URL

string
nullable
attachments

Attachments

Array<object>
nullable
Attachment

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

object
id

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
x

Width in pixels

integer format: int32
y

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

API representation of a video

object
id

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
inline_attachments

Inline attachments

Array<object>
nullable
Attachment

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

object
id

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
x

Width in pixels

integer format: int32
y

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

API representation of a video

object
id

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
files

Files

Array<object>
nullable
Attachment

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

object
id

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
x

Width in pixels

integer format: int32
y

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

API representation of a video

object
id

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
videos

Videos

Array<object>
nullable
Attachment

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

object
id

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
x

Width in pixels

integer format: int32
y

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

API representation of a video

object
id

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
keywords

Keywords

Array<object>
Keyword

API representation of a keyword

object
keywordId

Keyword ID

integer format: int64
layoutTemplate
One of:
PageTemplateMatch

The page builder template to render a category, publication, article, author or keyword with (the layoutTemplate field of their views). Fetch the layout with GET /cms/layout/key/{key}, or GET /cms/layout/{id} when key is null.

object
id

Layout ID of the template

integer format: int64
Example
31
key

Stable key of the template; null when not set

string
nullable
Example
opinion-article
name

Template name

string
Example
Opinion article
matchedBy

Why this template applies, most specific first: the content type (article templates only), the category itself, a parent category, or the publication; for author and keyword templates, the author or keyword itself

string
Allowed values: article_type category parent_category publication author keyword
Example
category
targetType

What the template is used for

string
Allowed values: article_type category publication author keyword
Example
category
targetId

ID of the content type, category, publication, author or keyword

integer format: int64
Example
14
name

Name

string
url

URL

string
slug

Slug

string
description

Description

string
nullable
articlesCount

Articles count

integer
replacedWith

If this keyword was replaced, id of replacement

nullable
display_name

Display name

string
nullable
translations

Translations

nullable
collection_id

Collection id

integer
nullable
image

Image URL

string
nullable
related
Array<object> recursive
elements

Elements (youtube, liveblogs, polls, quiz)

object
liveblogs

Live blogs in the article

Array<object>
nullable
LiveBlog

API representation of a liveblog

object
id

LiveBlog ID

integer format: int64
title

Title

string
start_date

Start date

string
nullable
end_date

End date

string
nullable
room_name

Websocket room name

string
preview

Preview messages

Array<object>
LiveBlogMessage

API representation of a liveblog message

object
id

Message ID

integer format: int64
timestamp

Timestamp

string
nullable
text

Text

string
nullable
title

Title

string
nullable
minute

Minute

string
nullable
minute_additional

Additional minute value

integer format: int64
typeId

Type id

string
nullable
imageLetter

Image letter/character

string
nullable
highlight

Highlight flag

boolean
html

HTML content

string
nullable
user

User display name

string
user_thumbnail

User thumbnail URL

string
nullable
polls

Polls in the article

Array<object>
nullable
Poll

API representation of a poll

object
id

Poll ID

integer format: int64
timestamp

Timestamp

string
question

Question

string
choices

Choices

Array<string>
votes

Votes

integer
slug

Slug

string
category
PollCategory

API representation of a poll category

object
id

Category ID

integer format: int64
name

Name

string
image

Image

string
results

Results

Array<object>
object
value

Number of votes

integer format: int64
percentage

Percentage of total votes

number format: float
message

Message

string
onlyLoggedIn

Only logged in

integer
endDate

End date

string
nullable
voted

Voted (only true when voting)

boolean
voted_choice

Voted choice (only valid when voting)

integer
closed

Closed

integer
quizzes

Quizzes in the article

Array<object>
nullable
Quiz

API representation of a quiz

object
id

Quiz ID

integer format: int64
name

Name

string
timestamp

Timestamp

string
image

Image

string
coverPicture

Cover picture

string
description

Description

string
share

Share

string
template

Template

string
allow_form

Allow form

string
introduction_message

Introduction message

string
thankyou_message

Thankyou message

string
terms

Terms

string
status

Status

string
questions

Questions

Array<object>
QuizQuestion

API representation of a quiz question

object
id

Question ID

integer format: int64
title

Title

string
resultText

Result text

string
image

Image

string
choices

Choices

Array<object>
QuizAnswer

API representation of a quiz answer

object
id

Answer ID

integer format: int64
answer

Answer text

string
letter

Letter

string
image

Image

string
correct

Correct

boolean
points

Points

integer
votes

Votes

integer
results

Results

Array<object>
QuizResult

API representation of a quiz result

object
id

Result ID

integer format: int64
result

Result

string
image

Image

string
letter

Letter

string
resultText

Result text

string
share

Share

string
twitterShare

Twitter share

string
minimum

Minimum

integer
maximum

Maximum

integer
votes

Votes

integer
youtube

YouTube video IDs in the article

Array<string>
nullable
seo

SEO object

object
search_title

Search title

string
search_description

Search description

string
social_title

Social title

string
social_description

Social description

string
social_image

Social image URL

string
time_to_read

Time to read (seconds)

integer
access_control

Access control enabled

boolean
access_allowed

Access allowed

boolean
status

Status

nullable
cached

Cached flag

boolean
children
Array<object> recursive
Example
{
  "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

External lists the frontend must provide (blocks with source.kind: "external"), by name, with the number of items needed so every external block is filled: fetch that many items (e.g. the category being rendered) and give each external block its slice (block.stream). Empty object when the layout has no external lists.

object
key
additional properties
object
items

Items to fetch for this list (largest offset + limit of its blocks)

integer
Example
{
  "main": {
    "items": 20
  }
}

404

Section titled “404”

No published layout with this key, or page builder not enabled