Get a keyword by ID or slug

GET

/cms/keyword/{keyword_id}

const url = 'https://api.example.com/cms/keyword/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/keyword/example \
  --header 'API-Key: <API-Key>'

Authorizations

ApiKeyAuth

Parameters

Path Parameters

keyword_id

required

string

Responses

200

Keyword found

application/json

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). For category, author, keyword and article pages, prefer their /layout endpoint (e.g. GET /cms/category/{category_id}/layout), which returns the object and this template already filled in one call. Otherwise fetch the layout with GET /cms/layout/key/{key}, or GET /cms/layout/{id} when key is null.

object

Layout ID of the template

integer format: int64

key

Stable key of the template; null when not set

string

nullable

name

Template name

string

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

targetType

What the template is used for

string

Allowed values: article_type category publication author keyword

targetId

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

integer format: int64

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

Example

{
  "layoutTemplate": {
    "id": 31,
    "key": "opinion-article",
    "name": "Opinion article",
    "matchedBy": "article_type",
    "targetType": "article_type",
    "targetId": 14
  }
}

404

Keyword not found