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.
The ID of the category. Fetch via GET /v2/projectversions/{projectVersionId}/categories.
Language code of the category translation (for example en, fr, de-DE, pt-BR). Use GET /v2/language/{projectVersionId} to list the codes enabled for a workspace. Defaults to en when omitted.
Set to true when rendering the category for an end-user — the response will resolve snippet, variable, and glossary merge codes. Do not pass true and then send the resolved content to an update endpoint.
When true, returns the latest published version. When false, returns the latest draft regardless of publish state.
Set to false to skip appending a SAS token to image/file URLs. SAS tokens are required for private/mixed projects.
Operation succeeded. Inspect the response envelope's success flag and the result/data payload.
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": 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?sv=2022-11-02&st=2024-06-18T07%3A12%3A34Z&se=2024-06-18T07%3A32%3A34Z&sr=b&sp=r&sig=LEA2ccLr1hMTZkAE48jsdaTYgRr6jNScPQ4x4E3vTss%3D",
"user_role": 7,
"last_login_at": "2024-06-13T14:30:00Z",
"unique_user_name": "peter-jone",
"sso_user_type": 0,
"is_sso_user": false,
"is_active": false
}
],
"created_at": "2024-06-13T14:30:00Z",
"modified_at": "2024-06-13T14:30:00Z",
"slug": "indexpage",
"is_fall_back_content": true,
"stale_status": {
"article_stale_status": 0,
"stale_reason": "",
"expired_at": "2024-06-13T14:30:00Z",
"is_from_document_settings": false,
"expire_days": 0
},
"content_type": "Markdown",
"current_workflow_status_id": null,
"is_block_editor": false,
"custom_fields": [
{
"field_id": "field-definition-id-1",
"name": "Category Type",
"type": 0,
"value": "Index Page"
},
{
"field_id": "field-definition-id-2",
"name": "Display Order",
"type": 6,
"value": 1
}
]
},
"extension_data": null,
"success": true,
"errors": [],
"warnings": [],
"information": []
}Get category version data
The ID of the category
Category title
Category page Markdown content
Category page WYSIWYG(HTML) content
Category page Advanced WYSIWYG content
Parent category ID
Project document version ID
The currently fetched version number of this category page
The version number that is currently published
The latest version number(revision) of this category page.
Indicates if Right to Left alignment is enabled for the category page language
Indicates if the category page is visible on the site
The status of the article: 0 - Draft, 3 - Published
The ID of the user that created the category page
The list of authors that contributed to this category page
V1 team account profile — identity, contact details, role, login state, and SSO flags. Returned by GET /v1/teams and GET /v1/teams/{userId}.
The ID of the team account.
First name.
Last name.
Email address.
URL of the user's profile picture (with SAS token appended for private/mixed projects).
The user's V1 role. See Document360.Core.Enums.UserAccess for the available values.
Timestamp of the most recent successful sign-in. null if the user has never signed in.
The unique display name (handle) for the user.
For SSO users, indicates the SSO provisioning state (e.g. invited, active).
True when the user was provisioned via SSO.
True when the user is active (not deactivated or pending invitation).
The date the category page was created
The date the category page was last modified
The slug of the category page
Indicates whether the category page content is a fallback of the default language content or not
Fresh - Category page is up-to-date Stale - Category page requires review
The freshness classification of the article (Fresh, Stale, ReviewPending, etc.). Defaults to Fresh.
Free-text explanation captured when the article was marked stale.
UTC date when this stale-status entry expires (article enters review).
True if the stale policy was inherited from project-level documentation settings rather than set on the article directly.
Number of days from publication after which the article should next be reviewed.
0 - Markdown 1 - WYSIWYG(HTML) 2 - Advanced WYSIWYG
Current Workflow status of the article
Custom field values associated with the category
Represents a custom field value with its definition metadata
Unique identifier of the custom field definition
The display name of the custom field
The type of the custom field. 0 = Text, 1 = TextArea, 2 = Dropdown, 3 = MultiSelectDropdown, 4 = Date, 5 = Boolean, 6 = Number
The value of the custom field. Type depends on field type:
- Text/TextArea: string
- Number: int or double
- Boolean: bool
- Date: DateTime
- Dropdown: string (selected option ID)
- MultiSelectDropdown: List
(array of selected option IDs)
Available options for Dropdown and MultiSelectDropdown fields. Omitted for other field types.
Option definition for dropdown fields
The option ID (use this value when updating)
The display label for the option
Extension data for customer API response
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.
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.
One structured error in a response's Document360.Core.Messages.Core.BaseResponse.errors array.
This is the Extension data object
A technical trace showing where the error occurred within the system. Intended for backend debugging.
A clear message explaining what caused the error. This helps quickly understand what went wrong.
A short, predefined code that identifies the type of error. Useful for logging the error or raising a support request.
Any structured metadata for the error object.
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.
One non-fatal warning attached to an otherwise-successful response.
Extension Data for customer Api warning
A plain message that describes the warning and helps understand what should be reviewed.
A short, predefined code that uniquely identifies the warning type.
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.
One informational message in a response's Document360.Core.Messages.Core.BaseResponse.information array. Non-error context the SPA may surface to the user.
Extension data for customer Api response information
A plain message offering helpful context about the response, such as confirmation of fallback logic or skipped operations.
The request body or query parameters failed validation. Inspect errors[].description for the offending fields.
Kindly verify the Categotry Id, version Number and Langauage code, and peroform the task again.
{
"extension_data": null,
"success": false,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "Category not found",
"error_code": "400",
"custom_data": null
}
],
"warnings": [],
"information": []
}Kindly verify the version Number and language code, and peroform the task again.
{
"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": []
}Extension data for customer API response
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.
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.
One structured error in a response's Document360.Core.Messages.Core.BaseResponse.errors array.
This is the Extension data object
A technical trace showing where the error occurred within the system. Intended for backend debugging.
A clear message explaining what caused the error. This helps quickly understand what went wrong.
A short, predefined code that identifies the type of error. Useful for logging the error or raising a support request.
Any structured metadata for the error object.
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.
One non-fatal warning attached to an otherwise-successful response.
Extension Data for customer Api warning
A plain message that describes the warning and helps understand what should be reviewed.
A short, predefined code that uniquely identifies the warning type.
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.
One informational message in a response's Document360.Core.Messages.Core.BaseResponse.information array. Non-error context the SPA may surface to the user.
Extension data for customer Api response information
A plain message offering helpful context about the response, such as confirmation of fallback logic or skipped operations.
Authentication failed — the api_token header is missing, malformed, or has been revoked.
Extension data for customer API response
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.
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.
One structured error in a response's Document360.Core.Messages.Core.BaseResponse.errors array.
This is the Extension data object
A technical trace showing where the error occurred within the system. Intended for backend debugging.
A clear message explaining what caused the error. This helps quickly understand what went wrong.
A short, predefined code that identifies the type of error. Useful for logging the error or raising a support request.
Any structured metadata for the error object.
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.
One non-fatal warning attached to an otherwise-successful response.
Extension Data for customer Api warning
A plain message that describes the warning and helps understand what should be reviewed.
A short, predefined code that uniquely identifies the warning type.
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.
One informational message in a response's Document360.Core.Messages.Core.BaseResponse.information array. Non-error context the SPA may surface to the user.
Extension data for customer Api response information
A plain message offering helpful context about the response, such as confirmation of fallback logic or skipped operations.
The requested resource was not found, or the supplied identifier does not exist in the project.
Extension data for customer API response
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.
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.
One structured error in a response's Document360.Core.Messages.Core.BaseResponse.errors array.
This is the Extension data object
A technical trace showing where the error occurred within the system. Intended for backend debugging.
A clear message explaining what caused the error. This helps quickly understand what went wrong.
A short, predefined code that identifies the type of error. Useful for logging the error or raising a support request.
Any structured metadata for the error object.
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.
One non-fatal warning attached to an otherwise-successful response.
Extension Data for customer Api warning
A plain message that describes the warning and helps understand what should be reviewed.
A short, predefined code that uniquely identifies the warning type.
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.
One informational message in a response's Document360.Core.Messages.Core.BaseResponse.information array. Non-error context the SPA may surface to the user.
Extension data for customer Api response information
A plain message offering helpful context about the response, such as confirmation of fallback logic or skipped operations.
Rate limit exceeded for this api_token. Wait for the duration in the Retry-After header before retrying.
Extension data for customer API response
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.
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.
One structured error in a response's Document360.Core.Messages.Core.BaseResponse.errors array.
This is the Extension data object
A technical trace showing where the error occurred within the system. Intended for backend debugging.
A clear message explaining what caused the error. This helps quickly understand what went wrong.
A short, predefined code that identifies the type of error. Useful for logging the error or raising a support request.
Any structured metadata for the error object.
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.
One non-fatal warning attached to an otherwise-successful response.
Extension Data for customer Api warning
A plain message that describes the warning and helps understand what should be reviewed.
A short, predefined code that uniquely identifies the warning type.
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.
One informational message in a response's Document360.Core.Messages.Core.BaseResponse.information array. Non-error context the SPA may surface to the user.
Extension data for customer Api response information
A plain message offering helpful context about the response, such as confirmation of fallback logic or skipped operations.