Get a keyword by ID or slug

GET

/cms/keyword/{keyword_id}

• The API server for the WhiteBeard News Suite
• Local development server for the WhiteBeard News Suite
• Local worker for the WhiteBeard News Suite

Authorizations

• ApiKeyAuth

Parameters

Path Parameters

keyword_id

required

string

Responses

200

Keyword found

Keyword

API representation of a keyword

object

keywordId

Keyword ID

integer format: int64

layoutTemplate

One of:

PageTemplateMatch

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

404

Keyword not found