Get category page with an ID

26 Sep 2023
5 Minutes to read
Contributors

Print
Share
Dark
Light

Get category page with an ID

Updated on 26 Sep 2023
5 Minutes to read
Contributors

Print
Share
Dark
Light

Article Summary

Share feedback

Thanks for sharing your feedback!

Get

/v2/Categories/{categoryId}/content/{langCode}

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

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 article content is not passed for update category endpoints.

Default"False"

isPublished

boolean

To get latest published article, set isPublished as true.

Default"False"

appendSASToken

boolean

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

Default"True"

Responses

200

Success

Success Response

This is an example for get category page succes response. \n Here you can view diffrent data included with multiple Authors associated with a category page.

{
  "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": 2,
    "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": "2023-09-26T06:34:59.4807035Z",
        "unique_user_name": "peter-jone",
        "sso_user_type": 0,
        "is_sso_user": false
      }
    ],
    "created_at": "2023-09-26T06:34:59.4807022Z",
    "modified_at": "2023-09-26T06:34:59.4807029Z",
    "slug": "indexpage",
    "is_fall_back_content": true,
    "stale_status": {
      "article_stale_status": 0,
      "stale_reason": "",
      "expired_at": "2023-09-26T06:34:59.4807054Z"
    },
    "content_type": "Markdown",
    "is_block_editor": false
  },
  "extension_data": null,
  "success": true,
  "errors": [],
  "warnings": [],
  "information": []
}

Expand All

object

category

object (CategoryVersionData)

string

The ID of the category

title

string

Category title

content

string

Category page content

html_content

string

Category page HTML content

block_content

string

Category page HTML block content

parent_category_id

string

Parent category ID

project_document_version_id

string

Project document version ID

version_number

integer (int32)

The currently fetched version number of this category page

public_version

integer (int32)

The version number that is currently published

latest_version

integer (int32)

The latest version number(revision) of this category page.

enable_rtl

boolean

Indicates if Right to Left alignment is enabled for the category page language

hidden

boolean

Indicates if the category page is visible on the site

status

integer (int32)

The status of the category page: 0 - Draft, 1 - In review, 2 - Public, 3 - Published, 4 - Deleted, 5 - Forked

Valid values[0,1,2,3,4,5]

created_by

string

The ID of the user that created the category page

authors

Array of object (UserProfileCustomer)

The list of authors that contributed to this category page

object

string

first_name

string

last_name

string

email_id

string

profile_logo_url

string

user_role

integer (int32)

Valid values[1,2,3,4,7]

last_login_at

string (date-time)

unique_user_name

string

sso_user_type

integer (int32)

SSO user type 0 - Normal user, 1 - SSO user, 2 - Invited SSO user

Valid values[0,1,2]

is_sso_user

boolean

created_at

string (date-time)

The date the category page was created

modified_at

string (date-time)

The date the category page was last modified

slug

string

The slug of the category page

is_fall_back_content

boolean

Indicates whether the category page content is a fallback of the default language content or not

stale_status

object (StaleStatus)

article_stale_status

integer (int32)

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

Valid values[0,1]

stale_reason

string

expired_at

string (date-time)

content_type

string

0 - Markdown content

1 - HTML content

2 - Block content

is_block_editor

boolean

extension_data

object (ExtensionDataObject)

success

boolean

Status indication for customer API response

errors

Array of object (BaseError)

Errors in the customer API response

object

extension_data

object (ExtensionDataObject)

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 (BaseWarning)

Warning in the customer API response

object

extension_data

object (ExtensionDataObject)

description

string

Warning description

warning_code

string

warning code for customer Api base response

information

Array of object (BaseInformation)

Information passed by the customer API response

object

extension_data

object (ExtensionDataObject)

description

string

status description for customer Api response information

400

Bad Request

Category not found

Kindly verify the Categotry Id, version Number and Langauage code, and peroform the task again.

{
  "category": null,
  "extension_data": null,
  "success": false,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "Category not found",
      "error_code": "400",
      "custom_data": null
    }
  ],
  "warnings": [],
  "information": []
}

Version not found

Kindly verify the version Number and language code, and peroform the task again.

{
  "category": null,
  "extension_data": null,
  "success": false,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "Category with Id ad6ef117-1e8f-4817-800b-6ed8e2304bf2 with the language code en does not contain version 2",
      "error_code": "400",
      "custom_data": null
    }
  ],
  "warnings": [],
  "information": []
}

Expand All

object

What's Next

Get category page content with an ID