Returns the full category tree (categories + their articles + child categories, recursively). This is the second discovery endpoint after GET /v2/projectversions — most integrations call this once to map out the workspace's categoryId and articleId values.
Set excludeArticles=true for a lighter payload when you only need the category skeleton.
Set securityVisibility=1 to restrict the result to private categories only.
Safe to retry; idempotent.
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 workspace (also called project version). Fetch via GET /v2/projectversions.
When true, the response omits articles inside categories (lighter payload). When false, articles are included.
Language code (for example en, fr, de-DE, pt-BR). Use GET /v2/language/{projectVersionId} to list the codes enabled for the workspace. When omitted, the workspace's default language is used.
When true, includes the category description in the response.
Optional protection level filter: 0 Public, 1 Private. When omitted, returns all categories regardless of protection level.
Operation succeeded. Inspect the response envelope's success flag and the result/data payload.
200 response in get list of categories within project version
{
"data": [
{
"articles": [
{
"url": null,
"exclude_from_external_search": false,
"security_visibility": null,
"id": "c31b0a18-5416-4cef-b165-83d9b52ada43",
"title": "Why did we build Document360?",
"public_version": 1,
"latest_version": 1,
"language_code": null,
"hidden": false,
"status": 0,
"order": 1,
"slug": "why-did-we-build-document360",
"content_type": null,
"translation_option": 0,
"is_shared_article": false,
"created_at": null,
"modified_at": null,
"current_workflow_status_id": "9fc4dd1a-ee83-489f-994d-ddf43c9b4b18"
}
],
"child_categories": [],
"exclude_from_external_search": false,
"security_visibility": 0,
"id": "f587e278-4205-4a07-a6b7-28dc9caf6f48",
"name": "Getting started",
"description": "This is the description of the getting started category.",
"project_version_id": "ad76e483-6ef7-4e43-b53f-4fe5e52sefw",
"order": 1,
"parent_category_id": null,
"hidden": false,
"icon": null,
"slug": "getting-started",
"language_code": null,
"category_type": 0,
"created_at": "2024-06-13T14:30:00Z",
"modified_at": "2024-06-13T14:30:00Z",
"status": null,
"content_type": null,
"current_workflow_status_id": "7fc4dd1a-ee83-489f-994d-ddf43c9b4b18"
}
],
"extension_data": null,
"success": true,
"errors": [],
"warnings": [],
"information": []
}The list of articles attached to this category
Url of the article
Indicates whether this article is excluded from external search engines. When true, the article will not be indexed by external search engines.
The protection level of the article: 0 - Public (accessible to all), 1 - Protected (requires authentication), 2 - Mixed (inherits from project/version settings). This determines who can access the article.
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
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).
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
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.
400 response in get list of categories within project version
{
"extension_data": null,
"success": true,
"errors": [],
"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.