Gets settings for the article

Updated on Dec 24, 2024

3 minute(s) read

Anand Murali

Prev Next

Get

/v2/Articles/{articleId}/{langCode}/settings

Security

API Key

Header parameter nameapi_token

Enter REST API key. To generate a key, go to Settings → Knowledge base portal → API tokens

Path parameters

articleId

stringRequired

The ID of the article

langCode

stringRequired

Language code of the article

Default"en"

Responses

200

Success

Success status Response

This is the sample response for Get-Article-Settings, You can verify the Slug, Tags, and relatedArticles.

{
  "data": {
    "slug": "5-basic-things-to-get-started",
    "seo_title": null,
    "description": null,
    "allow_comments": true,
    "show_table_of_contents": true,
    "featured_image_url": null,
    "tags": [
      "Getting started"
    ],
    "status_indicator": 1,
    "status_indicator_expiry_date": "2024-06-13T14:30:00Z",
    "exclude_from_search": false,
    "exclude_from_ai_search": false,
    "related_articles": [],
    "is_acknowledgement_enabled": false
  },
  "extension_data": null,
  "success": true,
  "errors": null,
  "warnings": [],
  "information": []
}

Expand All

object

data

object | null

Get article settings

slug

string | null

The slug of the article

seo_title

string | null

The SEO title of the article

description

string | null

The SEO description of the article

allow_comments

boolean

True indicates that comments are allowed in the article

show_table_of_contents

boolean

True indicates that Table of Contents are shown in the article

featured_image_url

string | null

URL of the featured image

tags

Array of string | null

List of tags associated to the article

string

status_indicator

integer (int32)

The status of the article: 0 - None, 1 - New, 2 - Updated, 3 - Custom

Valid values[ 0, 1, 2, 3 ]

status_indicator_expiry_date

string (date-time) | null

The number of days after which the article status will be removed

exclude_from_search

boolean

True indicates that the article will not appear in the Knowledge base search results

exclude_from_ai_search

boolean

related_articles

Array of object (RelatedArticleData) | null

List of related articles associated to the article

object

string | null

The ID of the article

title

string | null

The title of the article

hidden

boolean

True indicates that the article is hidden

slug

string | null

The slug of the article

is_acknowledgement_enabled

boolean

extension_data

object | null

Extention data for customer API response

success

boolean

Status indication for customer API response

errors

Array of object (BaseError) | null

Errors in the customer API response

object

extension_data

object | null

Thids is the Extention data object

stack_trace

string | null

Stack trace for error response message

description

string | null

Description for error cause

error_code

string | null

Error code for Api response

custom_data

object | null

property*

warnings

Array of object (BaseWarning) | null

Warnings in the customer API response

object

extension_data

object | null

Extention Data for customer Api warning

description

string | null

Warning description

warning_code

string | null

warning code for customer Api base response

information

Array of object (BaseInformation) | null

Information passed by the customer API response

object

extension_data

object | null

Extention data for customer Api response information

description

string | null

status description for customer Api response information

400

Bad Request

Article not found

Kindly verify your articleId and perform the task again. Also verify the langCode (language code) is mismatching.

{
  "extension_data": null,
  "success": true,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "Article not found",
      "error_code": null,
      "custom_data": null
    }
  ],
  "warnings": [],
  "information": []
}

Expand All

object

extension_data

object | null

Extention data for customer API response

success

boolean

Status indication for customer API response

errors

Array of object (BaseError) | null

Errors in the customer API response

object

extension_data

object | null

Thids is the Extention data object

stack_trace

string | null

Stack trace for error response message

description

string | null

Description for error cause

error_code

string | null

Error code for Api response

custom_data

object | null

property*

warnings

Array of object (BaseWarning) | null

Warnings in the customer API response

object

extension_data

object | null

Extention Data for customer Api warning

description

string | null

Warning description

warning_code

string | null

warning code for customer Api base response

information

Array of object (BaseInformation) | null

Information passed by the customer API response

object

extension_data

object | null

Extention data for customer Api response information

description

string | null

status description for customer Api response information

Was this article helpful?