Gets list of project versions

Prev Next
Get
/v2/ProjectVersions
Security
API Key: api_token
Header parameter nameapi_token

The API token used for authenticating the request. This must be passed as a header parameter. To generate an API token, go to Settings > Knowledge base portal > API tokens. This token must correspond to a valid workspace and permission level.

Responses
200

Success

200 Status response

The below example shows the status response 200.

{
  "data": [
    {
      "id": "46f48bc7-760f-4b07-b2d2-fce4aa8ba234",
      "version_number": 1.0,
      "base_version_number": 0.0,
      "version_code_name": "v1",
      "is_main_version": true,
      "is_beta": false,
      "is_public": true,
      "is_deprecated": false,
      "created_at": "2024-06-13T14:30:00Z",
      "modified_at": "2024-06-13T14:30:00Z",
      "language_versions": [
        {
          "id": "",
          "name": null,
          "code": "SS",
          "set_as_default": false,
          "hidden": false,
          "enable_rtl": true,
          "site_protection_level": 2,
          "is_inheritance_disabled": false,
          "has_inheritance_disabled_categories_or_articles": false,
          "country_flag_code": null,
          "display_name": null,
          "is_home_page_enabled": false,
          "version_display_name": null
        }
      ],
      "slug": "",
      "order": 0,
      "version_type": 0
    }
  ],
  "extension_data": null,
  "success": true,
  "errors": [],
  "warnings": [],
  "information": []
}
Expand All
object
data
Array of object (ProjectVersionCustomer) | null
object
id
string | null

The ID of the project version

version_number
number (double)

Project version number

base_version_number
number (double)

The version number from which this version is derived

version_code_name
string | null

Custom version name

is_main_version
boolean

"True" if this version is the main version after loading documentation

is_beta
boolean

"True" if this version is marked as Beta

is_public
boolean

"True" if this version is visible to the public

is_deprecated
boolean

"True" if this version is marked as deprecated

created_at
string (date-time)

The date and time the version was created

modified_at
string (date-time)

The last date and time the version was modified

language_versions
Array of object (Language) | null
object
id
string | null
name
string | null
code
string | null
set_as_default
boolean
hidden
boolean
enable_rtl
boolean
site_protection_level
integer (int32)
Valid values[ 0, 1, 2 ]
is_inheritance_disabled
boolean
has_inheritance_disabled_categories_or_articles
boolean
country_flag_code
string | null
display_name
string | null
is_home_page_enabled
boolean
version_display_name
string | null
slug
string | null
order
integer (int32)
version_type
integer (int32)

0 - KB workspace ; 1 - API Reference workspace;

Valid values[ 0, 1 ]
extension_data
object | null

Extension data for customer API response

success
boolean

Indicates the status of the API response. A value of true signifies that the request was successfully processed, while false indicates a failure or error occurred.

errors
Array of object (BaseError) | null

A list of errors encountered during the API request. Each error object provides details about the problem, including an error code and a message explaining the issue. This field is populated when the request fails or encounters issues.

object
extension_data
object | null

This is the Extension data object

stack_trace
string | null

A technical trace showing where the error occurred within the system. Intended for backend debugging.

description
string | null

A clear message explaining what caused the error. This helps quickly understand what went wrong.

error_code
string | null

A short, predefined code that identifies the type of error. Useful for logging the error or raising a support request.

custom_data
object | null

Any structured metadata for the error object.

property*
warnings
Array of object (BaseWarning) | null

A list of warnings generated during the API request. These are non-critical issues or recommendations that might affect the request but won't stop it from processing. Each warning object provides a message to inform the user of potential problems.

object
extension_data
object | null

Extension Data for customer Api warning

description
string | null

A plain message that describes the warning and helps understand what should be reviewed.

warning_code
string | null

A short, predefined code that uniquely identifies the warning type.

information
Array of object (BaseInformation) | null

Contains additional non-critical information relevant to the request or response. This field provides extra details that might assist in understanding the context of the API response but is not essential for processing.

object
extension_data
object | null

Extension data for customer Api response information

description
string | null

A plain message offering helpful context about the response, such as confirmation of fallback logic or skipped operations.