Sign in
articles

Get an article by its ID

Returns a single article by ID within the specified knowledge base.

Rate limit: 300 requests per minute

get/knowledge-bases/{id}/articles/{article_id}

Path parameters

idstring required

The KnowledgeBaseID of the article to fetch.

article_idstring required

The ID of the article to fetch.

Query parameters

languagestring

The language code to fetch the article in. If not provided, returns the default language.

Response

request_idstring

The request ID for tracking.

Example response

{
  "data": {
    "tags": [
      {
        "object_type": "issue"
      }
    ],
    "visibility_config": {
      "customer_visibility_condition": {
        "subfilters": [
          {
            "field": "state",
            "operator": "equals",
            "value": "new"
          }
        ]
      }
    }
  }
}

Changes

Changed in 3 of the 22 revisions of this API.131

  • fe3adb90ea451See the full diff
    • ○

      added the non-success response with the status 403

      response-non-success-status-added

  • b387b041ea8e1See the full diff
    • ▲

      the response property data/visibility_config/customer_visibility_condition/field became optional for the status 200

      response-property-became-optional

  • ad855d921ee93See the full diff
    • ●

      added the new account enum value to the data/tags/items/object_type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new article enum value to the data/tags/items/object_type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new issue enum value to the data/tags/items/object_type response property for the response status 200

      response-property-enum-value-added