user-site

Get

/v2/Categories/{categoryId}/versions/{langCode}/{versionNumber}

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

categoryId

stringRequired

The ID of the category

versionNumber

integer (int32) Required

Version number of the category

langCode

stringRequired

Language code of the category

Default"en"

Query parameters

isForDisplay

boolean

Set this to true, if you are displaying the category to the end-user. If true, the content of snippets or variables appears in the category. Note: If the value is true, ensure that the category content is not passed for update category endpoints.

Default"False"

appendSASToken

boolean

Set this to false to exclude appending SAS token for images/files

Default"True"

Responses

200

400

Show example

Success

Success Response

This is an sample category data by category version.

{
  "category": {
    "id": "5b291e6b-fa40-4ab9-941e-f8fffc23b376",
    "title": "IndexPage",
    "content": "Content is the information contained within communication media. This includes internet, cinema, television, radio, audio CDs, books, magazines, physical art, and live event content. It’s directed at an end-user or audience in the sectors of publishing, art, and communication",
    "html_content": "Content is the information contained within communication media. This includes internet, cinema, television, radio, audio CDs, books, magazines, physical art, and live event content. It’s directed at an end-user or audience in the sectors of publishing, art, and communication\n",
    "block_content": null,
    "parent_category_id": null,
    "project_document_version_id": "46f48bc7-760f-4b07-b2d2-fce4aa8ba234",
    "version_number": 1,
    "public_version": 1,
    "latest_version": 1,
    "enable_rtl": true,
    "hidden": false,
    "status": 0,
    "created_by": "f11efc6f-e968-4e95-82eb-85ad61559de8",
    "authors": [
      {
        "id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
        "first_name": "peter",
        "last_name": "jone",
        "email_id": "peterjone@mail.com",
        "profile_logo_url": "https://www.gravatar.com/avatar/FE29D578CBEC3945FC88BF4F10906A3E",
        "user_role": 7,
        "last_login_at": "2024-04-09T11:35:32Z",
        "unique_user_name": "peter-jone",
        "sso_user_type": 0,
        "is_sso_user": false
      }
    ],
    "created_at": "2024-04-09T11:35:32Z",
    "modified_at": "2024-04-09T11:35:32Z",
    "slug": "indexpage",
    "is_fall_back_content": true,
    "stale_status": {
      "article_stale_status": 0,
      "stale_reason": "",
      "expired_at": "2024-04-09T11:35:32Z"
    },
    "content_type": "Markdown",
    "is_block_editor": false
  },
  "extension_data": null,
  "success": false,
  "errors": null,
  "warnings": [],
  "information": []
}

Collapse all

object