Get article settings
  • Updated on 05 Apr 2019
  • 1 minute to read
  • Contributors
  • Print
  • Share
  • Dark
    Light

Get article settings

  • Print
  • Share
  • Dark
    Light

GET/articles/{id}/settings

Gets settings for the article


Header

Parameter Type Description
api_token string REST API key you can get it from Settings > API.

Route Parameters

Parameters highlighted in bold are mandatory

Parameter Type Description
id string ID of the article

Response

{
    "data": {
        "slug": "API Documentation",
        "seo_title": "",
        "description": "",
        "allow_comments": false,
        "show_table_of_contents": false,
        "featured_image_url": null,
        "tags": [
            "API",
            "Demo"
        ],
        "status_indicator": 0,
        "status_indicator_expiry_date": null,
        "exclude_from_search": false,
        "related_articles": [
            {
                "id": "bb1a1ae8-0cda-4886-9f73-e98f3d8cc737",
                "title": "Welcome !",
                "hidden": false,
                "slug": "welcome"
            }
        ]
    },
    "extension_data": null,
    "context": null,
    "success": true,
    "errors": [],
    "warnings": [],
    "information": []
}

Response Sample

Parameter Type Description
slug string The slug of the article
seo_title string The seo title of the article
description string The description of the article
allow_comments boolean Disable / Enable internal commenting on the article
show_table_of_contents boolean Disable / Enable article table of the contents on the knowledge base
featured_image_url string The url of the image that will be used as a featured image
tags string[] Custom article tags
status_indicator enumerated User site article status 0 - none, 1 - new, 2 - updated
status_indicator_expiry_date datetime The date time when the public article status is removed
exclude_from_search boolean Exclude article from search results on knowledge base
related_articles object[] list of articles related to this visible on knowledge base

Response > related_articles

Parameter Type Description
id string Article id
title string Article title
hidden boolean Article visibility status
slug string Article slug
Was this article helpful?