> ## Documentation Index > Fetch the complete documentation index at: https://apidocs.document360.com/llms.txt > Use this file to discover all available pages before exploring further. # Gets category page content with an ID ## OpenAPI ````json GET /v2/Categories/{categoryId}/content/{langCode} { "openapi": "3.0.1", "info": { "title": "Document360 Customer API", "description": "Document360 RESTful APIs let you integrate your documentation with your software — onboard readers, manage articles, automate publishing, and more.\n\nFull reference: [API Documentation](https://apidocs.document360.io/docs).\n\n## Authentication\nEvery request must include your API token in the `api_token` header. Generate tokens in the Document360 portal under **Settings → Knowledge base portal → API tokens**. Tokens are project-scoped and can be revoked at any time. The same token can be passed via the `api_token` query string for situations where headers are not configurable, but the header form is strongly preferred.\n\n## Project context\nMany endpoints implicitly resolve the project from the API token. When an endpoint requires explicit project context, pass the project identifier in the `ProjectId` header.\n\n## Identifiers — how to fetch them\nMost endpoints accept one or more identifiers as path, query, or body parameters. Use the discovery endpoints below to look them up programmatically rather than hard-coding values:\n\n| Identifier | What it is | Where to fetch it |\n| --- | --- | --- |\n| `projectVersionId` (a.k.a. workspaceId) | A workspace/version inside the project — content (articles, categories, languages) lives within one. | `GET /v2/projectversions` — returns all workspaces with their `id`. Required first to discover articles, categories, and languages. |\n| `categoryId` | A category in the category tree. | `GET /v2/projectversions/{projectVersionId}/categories` — returns the full category hierarchy with each category's `id`. |\n| `articleId` | An article inside a category. | `GET /v2/projectversions/{projectVersionId}/articles` — lists all articles in the workspace. Also available inside the categories tree response. |\n| `langCode` | Two-letter / locale code (`en`, `fr`, `de-DE`, `pt-BR`, …) of an article or category translation. | `GET /v2/language/{projectVersionId}` — returns the languages enabled for the workspace, including `code` and `name`. |\n| `versionNumber` | A specific version of an article or category translation. | `GET /v2/articles/{articleId}/{langCode}/versions` for articles, `GET /v2/categories/{categoryId}/{langCode}versions` for categories. |\n| `userId` (team account) | A portal user (team member). | `GET /v2/teams` — lists all team accounts with their `userId`. `GET /v2/teams/{userId}` returns full details for one. |\n| `groupId` (team) | A team account group. | `GET /v2/teams/groups`. |\n| `roleId` | A role assignable to team accounts. | `GET /v2/teams/roles`. |\n| `readerId` | A reader account (used for private docs / reader analytics). | `GET /v2/readers` — supports pagination and `searchEmail` filtering. |\n| `groupId` (reader) | A reader group. | `GET /v2/readers/groups`. |\n\n**Tip:** In the Document360 portal, the article and category IDs are visible in the URL when an item is open in the editor — e.g. `…/docs//edit/`. `projectId` and `projectVersionId` are visible in **Settings → API tokens** and **Documentation → Workspaces** respectively.\n\n## Query parameter casing\nV1/V2 query parameters use **snake_case** on the wire (for example `search_email`, `exclude_readers`, `version_number`). The server transparently maps snake_case query keys to the camelCase parameter names you see in this specification, so either casing is accepted, but snake_case is the documented convention for V1/V2.\n\n## Response envelope\nAll responses are wrapped in a consistent envelope:\n\n- `success` (boolean) — `true` when the operation succeeded, `false` otherwise. Always check this before reading the payload.\n- `errors` (array) — populated when `success` is `false`. Each entry has a human-readable `description`.\n- `warnings` / `information` (arrays) — non-fatal advisories returned alongside a successful response.\n- `result` or `data` — the operation's payload (the property name depends on the endpoint).\n\nHTTP status codes follow standard semantics (`200` success, `400` validation/business error, `401` missing or invalid token, `403` plan/permission restriction, `404` not found, `429` rate-limited, `5xx` server error). For non-`200` responses the envelope still applies — inspect `errors[].description` for details.\n\n## Rate limits\nEndpoints are rate-limited per API token per project. When throttled, the server returns `429 Too Many Requests` along with `Retry-After`, `X-RateLimit-Limit`, `X-RateLimit-Remaining`, and `X-RateLimit-Reset` headers. Use exponential backoff with jitter and respect the `Retry-After` header on the response.\n\n## Versioning\nAll routes are prefixed with the API version: `/v1/...` and `/v2/...`. V1 and V2 are stable; V3 is in Beta. New endpoints and fields may be added without notice in V1/V2 — they will never be removed or renamed in a backwards-incompatible way.", "version": "2.0.0" }, "servers": [ { "url": "https://apihub.document360.io", "description": "Document 360 API Hub" }, { "url": "https://apihub.us.document360.io", "description": "Document360 API Hub - US data center" }, { "url": "https://apihub.{private_hosting}.document360.io", "description": "Private hosting - Please provide the subdomain name.", "variables": { "private_hosting": { "default": "domain", "description": "Sub domain for private hosting" } } } ], "tags": [ { "name": "Articles", "description": "Create, read, update, publish, fork, and delete knowledge base articles. Manage article versions, settings, descriptions, workflow status, and bulk operations. Supports both Markdown and WYSIWYG/Block content types." }, { "name": "Categories", "description": "Manage the category hierarchy that organizes articles. Create, update, reorder, and delete categories; manage category content, settings, workflow status, and bulk operations." }, { "name": "Drive", "description": "Upload, organize, and manage media files and folders in Drive (used in articles and documentation)." }, { "name": "Readers", "description": "Manage reader accounts and reader groups for private documentation. Create readers, assign them to groups, and manage access scopes." }, { "name": "Teams", "description": "Manage team accounts (portal users), team groups, and role assignments within a project." }, { "name": "Project", "description": "Project-level operations: export and import project documentation as zip archives." }, { "name": "ProjectVersions", "description": "Manage workspaces (also called project versions) within a project. List, search, fetch settings, and inspect version metadata." }, { "name": "Language", "description": "Retrieve languages configured for a workspace." }, { "name": "Translations", "description": "Query article translation status across the configured languages." }, { "name": "CustomField", "description": "Retrieve custom field definitions configured for the project. Custom field values are written/read via the Article and Category settings endpoints." }, { "name": "APIReferences", "description": "Import OpenAPI/Swagger specifications into API reference documentation and inspect import logs." } ], "x-tagGroups": [ { "name": "Workspace", "tags": [ "Project", "ProjectVersions" ] }, { "name": "Content", "tags": [ "Articles", "Categories" ] }, { "name": "Media", "tags": [ "Drive" ] }, { "name": "Access", "tags": [ "Readers", "Teams" ] }, { "name": "Localization", "tags": [ "Language", "Translations" ] }, { "name": "Custom data", "tags": [ "CustomField" ] } ], "paths": { "/v2/Categories/{categoryId}/content/{langCode}": { "get": { "tags": [ "Categories" ], "summary": "Gets category page content with an ID", "operationId": "getCategoryData", "parameters": [ { "name": "categoryId", "in": "path", "description": "The ID of the category. Fetch via `GET /v2/projectversions/{projectVersionId}/categories`.", "required": true, "schema": { "type": "string" }, "example": "de104b39-db97-4509-8d4c-deeac74d448b" }, { "name": "langCode", "in": "path", "description": "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.", "required": true, "schema": { "type": "string", "default": "en" }, "example": "en" }, { "name": "isForDisplay", "in": "query", "description": "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.", "schema": { "type": "boolean", "default": false }, "example": false }, { "name": "isPublished", "in": "query", "description": "When `true`, returns the latest published version. When `false`, returns the latest draft regardless of publish state.", "schema": { "type": "boolean", "default": false }, "example": false }, { "name": "appendSASToken", "in": "query", "description": "Set to `false` to skip appending a SAS token to image/file URLs. SAS tokens are required for private/mixed projects.", "schema": { "type": "boolean", "default": true }, "example": true } ], "responses": { "200": { "description": "Operation succeeded. Inspect the response envelope's `success` flag and the `result`/`data` payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCategoryContentResponse" }, "examples": { "Success Response": { "summary": "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.", "value": { "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, "version_type": null, "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:00", "unique_user_name": "peter-jone", "sso_user_type": 0, "is_sso_user": false, "is_active": false } ], "created_at": "2024-06-13T14:30:00", "modified_at": "2024-06-13T14:30:00", "slug": "indexpage", "is_fall_back_content": true, "stale_status": { "article_stale_status": 0, "stale_reason": "", "expired_at": "2024-06-13T14:30:00", "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": [] } }, "V2 Response (custom_fields_data)": { "summary": "V2 callers receive custom_fields_data instead of custom_fields. Values are in their native type — string, number, boolean. Multi-select fields are returned as a comma-separated string. Fields with no value are included as null.", "value": { "category": { "id": "5b291e6b-fa40-4ab9-941e-f8fffc23b376", "title": "IndexPage", "content": null, "html_content": null, "block_content": null, "parent_category_id": null, "project_document_version_id": "46f48bc7-760f-4b07-b2d2-fce4aa8ba234", "version_number": 1, "public_version": 0, "latest_version": 0, "enable_rtl": false, "hidden": false, "status": 0, "version_type": null, "created_by": null, "authors": [], "created_at": "0001-01-01T00:00:00", "modified_at": "0001-01-01T00:00:00", "slug": null, "is_fall_back_content": false, "stale_status": null, "content_type": "Markdown", "current_workflow_status_id": null, "is_block_editor": false, "custom_fields_data": { "Category Type": "Index Page", "Display Order": 1, "Tags": "Getting Started, Tutorials", "Is Featured": false, "Notes": null } }, "extension_data": null, "success": true, "errors": [], "warnings": [], "information": [] } } } } } }, "400": { "description": "The request body or query parameters failed validation. Inspect `errors[].description` for the offending fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Category not found": { "summary": "Kindly verify the Categotry Id, version Number and Langauage code, and peroform the task again.", "value": { "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": { "summary": "Kindly verify the version Number and language code, and peroform the task again.", "value": { "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": [] } } } } } }, "401": { "description": "Authentication failed — the `api_token` header is missing, malformed, or has been revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" } } } }, "404": { "description": "The requested resource was not found, or the supplied identifier does not exist in the project.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" } } } }, "429": { "description": "Rate limit exceeded for this api_token. Wait for the duration in the `Retry-After` header before retrying.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying the request.", "schema": { "type": "integer", "format": "int32" } }, "X-RateLimit-Limit": { "description": "The maximum number of requests allowed in the current window.", "schema": { "type": "integer", "format": "int32" } }, "X-RateLimit-Remaining": { "description": "The number of requests remaining in the current window.", "schema": { "type": "integer", "format": "int32" } }, "X-RateLimit-Reset": { "description": "Unix timestamp (seconds) at which the current rate-limit window resets.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" } } } } }, "security": [ { "api_token": [] } ] } } }, "components": { "schemas": { "GetCategoryContentResponse": { "type": "object", "properties": { "category": { "allOf": [ { "$ref": "#/components/schemas/CategoryVersionData" } ], "description": "Get category version data", "nullable": true }, "extension_data": { "allOf": [ { "$ref": "#/components/schemas/ExtensionDataObject" } ], "description": "Extension data for customer API response", "nullable": true }, "success": { "type": "boolean", "description": "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.", "readOnly": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/BaseError" }, "description": "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.", "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/BaseWarning" }, "description": "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.", "nullable": true }, "information": { "type": "array", "items": { "$ref": "#/components/schemas/BaseInformation" }, "description": "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.", "nullable": true } }, "additionalProperties": false }, "CustomerApiBaseResponse": { "type": "object", "properties": { "extension_data": { "allOf": [ { "$ref": "#/components/schemas/ExtensionDataObject" } ], "description": "Extension data for customer API response", "nullable": true }, "success": { "type": "boolean", "description": "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.", "readOnly": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/BaseError" }, "description": "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.", "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/BaseWarning" }, "description": "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.", "nullable": true }, "information": { "type": "array", "items": { "$ref": "#/components/schemas/BaseInformation" }, "description": "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.", "nullable": true } }, "additionalProperties": false }, "CategoryVersionData": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the category", "nullable": true, "readOnly": true }, "title": { "type": "string", "description": "Category title", "nullable": true }, "content": { "type": "string", "description": "Category page Markdown content", "nullable": true }, "html_content": { "type": "string", "description": "Category page WYSIWYG(HTML) content", "nullable": true }, "block_content": { "type": "string", "description": "Category page Advanced WYSIWYG content", "nullable": true }, "parent_category_id": { "type": "string", "description": "Parent category ID", "nullable": true }, "project_document_version_id": { "type": "string", "description": "Project document version ID", "nullable": true }, "version_number": { "type": "integer", "description": "The currently fetched version number of this category page", "format": "int32" }, "public_version": { "type": "integer", "description": "The version number that is currently published", "format": "int32", "readOnly": true }, "latest_version": { "type": "integer", "description": "The latest version number(revision) of this category page.", "format": "int32", "readOnly": true }, "enable_rtl": { "type": "boolean", "description": "Indicates if Right to Left alignment is enabled for the category page language" }, "hidden": { "type": "boolean", "description": "Indicates if the category page is visible on the site" }, "status": { "enum": [ "draft", "published" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/ArticleStatusCustomer" } ], "description": "The status of the article: 0 - Draft, 3 - Published", "x-enumNames": [ "Draft", "Published" ], "x-enum-varnames": [ "Draft", "Published" ], "x-ms-enum": { "name": "ArticleStatusCustomer", "modelAsString": true } }, "version_type": { "type": "string", "description": "Derived version discriminator (version-less collab): draft, published, or system_backup. Null when collaborative editing is not enabled for the project. Display/system-backup ordinals are exposed only by the versions-list endpoint.", "nullable": true }, "created_by": { "type": "string", "description": "The ID of the user that created the category page", "nullable": true }, "authors": { "type": "array", "items": { "$ref": "#/components/schemas/UserProfileCustomer" }, "description": "The list of authors that contributed to this category page", "nullable": true }, "created_at": { "type": "string", "description": "The date the category page was created", "format": "date-time", "readOnly": true }, "modified_at": { "type": "string", "description": "The date the category page was last modified", "format": "date-time", "readOnly": true }, "slug": { "type": "string", "description": "The slug of the category page", "nullable": true, "readOnly": true }, "is_fall_back_content": { "type": "boolean", "description": "Indicates whether the category page content is a fallback of the default language content or not" }, "stale_status": { "allOf": [ { "$ref": "#/components/schemas/StaleStatus" } ], "description": "Fresh - Category page is up-to-date\r\nStale - Category page requires review", "nullable": true }, "content_type": { "type": "string", "description": "0 - Markdown\r\n1 - WYSIWYG(HTML)\r\n2 - Advanced WYSIWYG", "nullable": true }, "current_workflow_status_id": { "type": "string", "description": "Current Workflow status of the article", "nullable": true }, "is_block_editor": { "type": "boolean", "readOnly": true }, "custom_fields": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValueResponse" }, "description": "Custom field values associated with the category. Returned for V1 callers only.", "nullable": true }, "custom_fields_data": { "type": "object", "additionalProperties": { "nullable": true }, "description": "Custom field values as a compact key-value map. Returned for V2 callers only.\r\nKey is the field label. Value is in its native type: string, number, boolean, or a comma-separated string of labels for multi-select.", "nullable": true } }, "additionalProperties": false }, "ExtensionDataObject": { "type": "object", "additionalProperties": false }, "BaseError": { "type": "object", "properties": { "extension_data": { "allOf": [ { "$ref": "#/components/schemas/ExtensionDataObject" } ], "description": "This is the Extension data object", "nullable": true }, "stack_trace": { "type": "string", "description": "A technical trace showing where the error occurred within the system. Intended for backend debugging.", "nullable": true }, "description": { "type": "string", "description": "A clear message explaining what caused the error. This helps quickly understand what went wrong.", "nullable": true }, "error_code": { "type": "string", "description": "A short, predefined code that identifies the type of error. Useful for logging the error or raising a support request.", "nullable": true }, "custom_data": { "type": "object", "additionalProperties": {}, "description": "Any structured metadata for the error object.", "nullable": true } }, "additionalProperties": false, "description": "One structured error in a response's Document360.Core.Messages.Core.BaseResponse.errors array." }, "BaseWarning": { "type": "object", "properties": { "extension_data": { "allOf": [ { "$ref": "#/components/schemas/ExtensionDataObject" } ], "description": "Extension Data for customer Api warning", "nullable": true }, "description": { "type": "string", "description": "A plain message that describes the warning and helps understand what should be reviewed.", "nullable": true }, "warning_code": { "type": "string", "description": "A short, predefined code that uniquely identifies the warning type.", "nullable": true } }, "additionalProperties": false, "description": "One non-fatal warning attached to an otherwise-successful response." }, "BaseInformation": { "type": "object", "properties": { "extension_data": { "allOf": [ { "$ref": "#/components/schemas/ExtensionDataObject" } ], "description": "Extension data for customer Api response information", "nullable": true }, "description": { "type": "string", "description": "A plain message offering helpful context about the response, such as confirmation of fallback logic or skipped operations.", "nullable": true } }, "additionalProperties": false, "description": "One informational message in a response's Document360.Core.Messages.Core.BaseResponse.information array. Non-error context the SPA may surface to the user." }, "ArticleStatusCustomer": { "enum": [ "draft", "published" ], "type": "string", "description": "The status of the article: 0 - Draft, 3 - Published", "x-enumNames": [ "Draft", "Published" ], "x-enum-varnames": [ "Draft", "Published" ], "x-ms-enum": { "name": "ArticleStatusCustomer", "modelAsString": true } }, "UserProfileCustomer": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the team account.", "nullable": true, "readOnly": true }, "first_name": { "type": "string", "description": "First name.", "nullable": true }, "last_name": { "type": "string", "description": "Last name.", "nullable": true }, "email_id": { "type": "string", "description": "Email address.", "nullable": true }, "profile_logo_url": { "type": "string", "description": "URL of the user's profile picture (with SAS token appended for private/mixed projects).", "nullable": true }, "user_role": { "enum": [ "administrator", "editor", "draftWriter", "reader", "owner" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/UserAccess" } ], "description": "The user's V1 role. See Document360.Core.Enums.UserAccess for the available values.", "x-enumNames": [ "Administrator", "Editor", "DraftWriter", "Reader", "Owner" ], "x-enum-varnames": [ "Administrator", "Editor", "DraftWriter", "Reader", "Owner" ], "x-ms-enum": { "name": "UserAccess", "modelAsString": true } }, "last_login_at": { "type": "string", "description": "Timestamp of the most recent successful sign-in. `null` if the user has never signed in.", "format": "date-time", "nullable": true, "readOnly": true }, "unique_user_name": { "type": "string", "description": "The unique display name (handle) for the user.", "nullable": true }, "sso_user_type": { "enum": [ "normalUser", "ssoUser", "ssoUserInvited" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/SSOUserTypes" } ], "description": "For SSO users, indicates the SSO provisioning state (e.g. invited, active).", "x-enumNames": [ "NormalUser", "SSOUser", "SSOUserInvited" ], "x-enum-varnames": [ "NormalUser", "SSOUser", "SSOUserInvited" ], "x-ms-enum": { "name": "SSOUserTypes", "modelAsString": true } }, "is_sso_user": { "type": "boolean", "description": "`True` when the user was provisioned via SSO." }, "is_active": { "type": "boolean", "description": "`True` when the user is active (not deactivated or pending invitation)." } }, "additionalProperties": false, "description": "V1 team account profile — identity, contact details, role, login state, and SSO flags. Returned by `GET /v1/teams` and `GET /v1/teams/{userId}`." }, "StaleStatus": { "type": "object", "properties": { "article_stale_status": { "enum": [ "fresh", "stale" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/ArticleStaleStatus" } ], "description": "The freshness classification of the article (Fresh, Stale, ReviewPending, etc.). Defaults to Fresh.", "x-enumNames": [ "Fresh", "Stale" ], "x-enum-varnames": [ "Fresh", "Stale" ], "x-ms-enum": { "name": "ArticleStaleStatus", "modelAsString": true } }, "stale_reason": { "type": "string", "description": "Free-text explanation captured when the article was marked stale.", "nullable": true }, "expired_at": { "type": "string", "description": "UTC date when this stale-status entry expires (article enters review).", "format": "date-time" }, "is_from_document_settings": { "type": "boolean", "description": "True if the stale policy was inherited from project-level documentation settings rather than set on the article directly." }, "expire_days": { "type": "integer", "description": "Number of days from publication after which the article should next be reviewed.", "format": "int32" } }, "additionalProperties": false, "description": "Freshness/review state for an article: whether it's still considered fresh, the\r\nreason it was marked stale, when the review window expires and how the policy was set." }, "CustomFieldValueResponse": { "type": "object", "properties": { "field_id": { "type": "string", "description": "Unique identifier of the custom field definition", "nullable": true }, "name": { "type": "string", "description": "The display name of the custom field", "nullable": true }, "type": { "enum": [ "text", "textArea", "dropdown", "multiSelectDropdown", "date", "boolean", "number" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/CustomFieldType" } ], "description": "The type of the custom field. 0 = Text, 1 = TextArea, 2 = Dropdown, 3 = MultiSelectDropdown, 4 = Date, 5 = Boolean, 6 = Number", "x-enumNames": [ "Text", "TextArea", "Dropdown", "MultiSelectDropdown", "Date", "Boolean", "Number" ], "x-enum-varnames": [ "Text", "TextArea", "Dropdown", "MultiSelectDropdown", "Date", "Boolean", "Number" ], "x-ms-enum": { "name": "CustomFieldType", "modelAsString": true } }, "value": { "description": "The value of the custom field. Type depends on field type:\r\n- Text/TextArea: string\r\n- Number: int or double\r\n- Boolean: bool\r\n- Date: DateTime\r\n- Dropdown: string (selected option ID)\r\n- MultiSelectDropdown: List (array of selected option IDs)", "nullable": true }, "options": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldOptionResponse" }, "description": "Available options for Dropdown and MultiSelectDropdown fields.\r\nOmitted for other field types.", "nullable": true } }, "additionalProperties": false, "description": "Represents a custom field value with its definition metadata" }, "UserAccess": { "enum": [ "administrator", "editor", "draftWriter", "reader", "owner" ], "type": "string", "description": "Predefined access role for a project user. Used in the V1 Customer API to assign or filter users by role. Newer integrations should prefer the role IDs exposed by `GET /v2/teams/roles`.", "x-enumNames": [ "Administrator", "Editor", "DraftWriter", "Reader", "Owner" ], "x-enum-varnames": [ "Administrator", "Editor", "DraftWriter", "Reader", "Owner" ], "x-ms-enum": { "name": "UserAccess", "modelAsString": true } }, "SSOUserTypes": { "enum": [ "normalUser", "ssoUser", "ssoUserInvited" ], "type": "string", "description": "SSO user type 0 - Normal user, 1 - SSO user, 2 - Invited SSO user", "x-enumNames": [ "NormalUser", "SSOUser", "SSOUserInvited" ], "x-enum-varnames": [ "NormalUser", "SSOUser", "SSOUserInvited" ], "x-ms-enum": { "name": "SSOUserTypes", "modelAsString": true } }, "ArticleStaleStatus": { "enum": [ "fresh", "stale" ], "type": "string", "description": "The status of the article: 0 - None, 1 - New, 2 - Updated, 3 - Custom", "x-enumNames": [ "Fresh", "Stale" ], "x-enum-varnames": [ "Fresh", "Stale" ], "x-ms-enum": { "name": "ArticleStaleStatus", "modelAsString": true } }, "CustomFieldType": { "enum": [ "text", "textArea", "dropdown", "multiSelectDropdown", "date", "boolean", "number" ], "type": "string", "description": "Possible values: `\"text\"` = Text, `\"textArea\"` = TextArea, `\"dropdown\"` = Dropdown, `\"multiSelectDropdown\"` = MultiSelectDropdown, `\"date\"` = Date, `\"boolean\"` = Boolean, `\"number\"` = Number", "x-enumNames": [ "Text", "TextArea", "Dropdown", "MultiSelectDropdown", "Date", "Boolean", "Number" ], "x-enum-varnames": [ "Text", "TextArea", "Dropdown", "MultiSelectDropdown", "Date", "Boolean", "Number" ], "x-ms-enum": { "name": "CustomFieldType", "modelAsString": true } }, "CustomFieldOptionResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "The option ID (use this value when updating)", "nullable": true, "readOnly": true }, "label": { "type": "string", "description": "The display label for the option", "nullable": true } }, "additionalProperties": false, "description": "Option definition for dropdown fields" } }, "securitySchemes": { "api_token": { "type": "apiKey", "description": "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.", "name": "api_token", "in": "header" } } } } ````