Contents x
Gets settings for the article
  • 16 Mar 2023
  • 2 Minutes to read
  • Contributors
  • Print
  • Dark
    Light
Contents

Gets settings for the article

  • Updated on 16 Mar 2023
  • 2 Minutes to read
  • Contributors
  • Print
  • Dark
    Light
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
string Required

The ID of the article

langCode
string Required

Language code of the article

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": "2023-03-16T13:17:47.3623832Z",
    "exclude_from_search": false,
    "related_articles": []
  },
  "extension_data": null,
  "success": true,
  "errors": null,
  "warnings": [],
  "information": []
}
Expand All
object
data
object
slug
string
seo_title
string
description
string
allow_comments
boolean
show_table_of_contents
boolean
featured_image_url
string
tags
Array of string
status_indicator
integer
Valid values[0,1,2,3]
status_indicator_expiry_date
string
exclude_from_search
boolean
related_articles
Array of object
object
id
string
title
string
hidden
boolean
slug
string
extension_data
object
success
boolean

Status indication for customer Api response

errors
Array of object

Errors in the customer Api response

object
extension_data
stack_trace
string

Stack trace for error response message

description
string

Description for error cause

error_code
string

Error code for Api resonse

custom_data
object
warnings
Array of object

Warning in the customer Api response

object
extension_data
description
string

Warning description

warning_code
string

warning code for customer Api base response

information
Array of object

Information passed by the customer Api response

object
extension_data
description
string

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.

{
  "data": null,
  "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
data
object
slug
string
seo_title
string
description
string
allow_comments
boolean
show_table_of_contents
boolean
featured_image_url
string
tags
Array of string
status_indicator
integer
Valid values[0,1,2,3]
status_indicator_expiry_date
string
exclude_from_search
boolean
related_articles
Array of object
object
id
string
title
string
hidden
boolean
slug
string
extension_data
object
success
boolean

Status indication for customer Api response

errors
Array of object

Errors in the customer Api response

object
extension_data
stack_trace
string

Stack trace for error response message

description
string

Description for error cause

error_code
string

Error code for Api resonse

custom_data
object
warnings
Array of object

Warning in the customer Api response

object
extension_data
description
string

Warning description

warning_code
string

warning code for customer Api base response

information
Array of object

Information passed by the customer Api response

object
extension_data
description
string

status description for customer Api response information

Was this article helpful?
What's Next