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 relative URL of the category (without domain). For example: "/workspace/docs/en/category-slug"
Determines how the API handles redirection when a redirection rule is configured for the requested article, category, or document.
- 0 - None – Returns the content of the originally requested resource without applying any redirection.
- 1 - RedirectOnly – Returns an HTTP 302 response along with the redirected resource's URL, without fetching its content.
- 2 - RedirectWithContent – Automatically follows the redirection rule and returns the content of the final redirected resource.
Set to true when rendering the category for an end-user — the response will resolve snippet, variable, and glossary merge codes.
When true, returns the latest published version. When false, returns the latest draft.
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.
Response for getting a category by URL
Contains details of the retrieved document, which can be an article or a category.
The unique ID of the document.
The Name of the document.
A short description or summary of the document.
The ID of the project version where the document is located.
The position the category inside the parent category
The ID of the parent category containing this document. Returns null for top-level categories.
Indicates if the category is visible on the site ( If "false," all the child categories and articles will be hidden as well )
The slug (URL-friendly identifier) of the document.
The document content in Markdown format. Populated when the editor type is Markdown.
Returns true if right-to-left text alignment is enabled for the selected language for the document.
The document content in HTML format. Populated when the editor type is WYSIWYG (HTML). For Markdown editors, this field is read-only.
The version number of the document currently fetched.
The editor type used for the document. Valid values: 0 - Markdown, 1 - WYSIWYG(HTML), 2 - Advanced WYSIWYG
The date and time when the document was created.
The date and time when the document was last modified.
The status of the page type category: 0 - Draft, 3 - Published
The editor type used for the document. Valid values: 0 - Markdown, 1 - WYSIWYG(HTML), 2 - Advanced WYSIWYG
The current workflow status ID of the document.
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.
The language code of the category
Lists the languages the article or category is available in, along with their translation status and slug
Represents information about an available language translation for an article or category.
The language code of the translated document.
The URL of the translated document.
The translation status of the document. Valid values: 0 - None, 1 - Need Translation, 2 - Translated, 3 - In Progress
Contains SEO settings and exclusion preferences for the document.
The SEO title of the document.
The SEO description of the document.
Returns true if the document is excluded from external search engines. When enabled, Document360 automatically adds a robots meta tag and removes the document from the sitemap it generates.
Indicates the visibility level of the article.Valid values are: 0 - Public(accessible to all readers) 1 - Private(accessible only to authenticated users or specific teams).
Compact contributor info — identity and profile picture only. Returned as part of article/category author lists.
The unique identifier of the contributor.
The contributor's first name.
The contributor's last name.
The email address of the contributor.
The profile logo URL of the contributor.
The list of articles attached to this category
Compact article representation — title, slug, current/latest version numbers, hierarchy position, and basic settings. Returned in list endpoints and create/bulk-create responses where the full content body is not required.
The ID of the article
The article title
The article version number(revision) that is currently published
The latest version number of this article
The default language code
Indicates if the article is visible on the site
The status of the article: 0 - Draft, 3 - Published
The position of the article inside the parent category
The slug of the article
The content type of the article: Markdown = 0, Wysiwyg = 1, Block = 2
The translation status of the document. Valid values: 0 - None, 1 - Need Translation, 2 - Translated, 3 - In Progress
True indicates that the article is shared
Article created date time
Article modified date time
Current Workflow status of the article
The list of categories attached to this category
Full category payload — extends Document360.Core.Models.Public.Categories.CategoryDataBaseCustomer with the articles and child categories that live inside this category. Forms the recursive tree returned by GET /v2/projectversions/{projectVersionId}/categories.
The list of articles attached to this category
Compact article representation — title, slug, current/latest version numbers, hierarchy position, and basic settings. Returned in list endpoints and create/bulk-create responses where the full content body is not required.
The ID of the article
The article title
The article version number(revision) that is currently published
The latest version number of this article
The default language code
Indicates if the article is visible on the site
The status of the article: 0 - Draft, 3 - Published
The position of the article inside the parent category
The slug of the article
The content type of the article: Markdown = 0, Wysiwyg = 1, Block = 2
The translation status of the document. Valid values: 0 - None, 1 - Need Translation, 2 - Translated, 3 - In Progress
True indicates that the article is shared
Article created date time
Article modified date time
Current Workflow status of the article
The list of categories attached to this category
Full category payload — extends Document360.Core.Models.Public.Categories.CategoryDataBaseCustomer with the articles and child categories that live inside this category. Forms the recursive tree returned by GET /v2/projectversions/{projectVersionId}/categories.
The ID of the category
Name of the category
Description of the category
The ID of the project version where this category is located
The position the category inside the parent category
The ID of the parent category ( null if top-level )
Indicates if the category is visible on the site ( If "false," all the child categories and articles will be hidden as well )
Unicode representation of the icon or image URL
The slug of the category
Language code of the category
0 - Folder, 1 - Page, 2 - Index
Category created date time
Category modified date time
The status of the page type category: 0 - Draft, 3 - Published
The content type of the page type category: Markdown = 0, Wysiwyg = 1, Block = 2
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.
Resource has been redirected. The Location header carries the new URL.
The below example shows that the given exportId is Invalid. Track your export Id form /v2/Project/Export.
{
"extension_data": null,
"success": true,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "Invalid export id",
"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.
The request body or query parameters failed validation. Inspect errors[].description for the offending fields.
The below example shows that the given exportId is Invalid. Track your export Id form /v2/Project/Export.
{
"extension_data": null,
"success": true,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "Invalid export id",
"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.
The below example shows that the given exportId is Invalid. Track your export Id form /v2/Project/Export.
{
"extension_data": null,
"success": true,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "Invalid export id",
"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.
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.