{"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/Articles/{articleId}/{langCode}":{"put":{"tags":["Articles"],"summary":"Updates an article with the ID","description":"Partial update — only the fields present in the request body are written. Omitted fields preserve their current values.\r\nIdempotent: replaying the same body twice produces the same final state.\r\nUse `PUT /v2/articles/{articleId}/{langCode}/settings` for settings-only changes (slug, SEO, status indicator).","operationId":"updateArticle","parameters":[{"name":"articleId","in":"path","description":"The ID of the article. Fetch via `GET /v2/projectversions/{projectVersionId}/articles`.","required":true,"schema":{"type":"string"},"example":"a1096061-e842-41fd-9085-494095e401b9"},{"name":"langCode","in":"path","description":"Language code of the article 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"}],"requestBody":{"description":"Partial update payload — only the fields present in the request body are updated. Do not pass content fetched with `isForDisplay=true`; the resolved merge codes would overwrite the source.","content":{"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/UpdateArticleRequest"}]},"examples":{"Update article wth article Id for default language":{"summary":"Update the article with needed information such as title, content, html_content, category_id, hidden, version_number, translation_option for default language,source and order.","value":{"title":"updated article title","content":"Hi this is an API article Sample. This is updated.","html_content":"

Hi this is an API article Sample. This is updated.

","category_id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","hidden":true,"version_number":1,"translation_option":"0","source":"uat","order":0}},"Update article wth article Id for article in the state of need translation":{"summary":"Update the article with needed information such as title, content, html_content, category_id, hidden, version_number, translation_option as need translation, source and order.","value":{"title":"updated article title","content":"Hi this is an API article Sample. This is updated.","html_content":"

Hi this is an API article Sample. This is updated.

","category_id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","hidden":true,"version_number":1,"translation_option":"1","source":"uat","order":0}},"Update article wth article Id with translation you had made":{"summary":"Update the article with needed information such as title, content, html_content, category_id, hidden, version_number, translation_option as translated, source and order.","value":{"title":"updated article title","content":"Hi this is an API article Sample. This is updated.","html_content":"

Hi this is an API article Sample. This is updated.

","category_id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","hidden":true,"version_number":1,"translation_option":"2","source":"uat","order":0}}}},"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/UpdateArticleRequest"}]},"examples":{"Update article wth article Id for default language":{"summary":"Update the article with needed information such as title, content, html_content, category_id, hidden, version_number, translation_option for default language,source and order.","value":{"title":"updated article title","content":"Hi this is an API article Sample. This is updated.","html_content":"

Hi this is an API article Sample. This is updated.

","category_id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","hidden":true,"version_number":1,"translation_option":"2","source":"uat","order":0}}}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/UpdateArticleRequest"}]},"examples":{"Update article wth article Id for default language":{"summary":"Update the article with needed information such as title, content, html_content, category_id, hidden, version_number, translation_option for default language,source and order.","value":{"title":"updated article title","content":"Hi this is an API article Sample. This is updated.","html_content":"

Hi this is an API article Sample. This is updated.

","category_id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","hidden":true,"version_number":1,"translation_option":"2","source":"uat","order":0}}}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/UpdateArticleRequest"}]},"examples":{"Update article wth article Id for default language":{"summary":"Update the article with needed information such as title, content, html_content, category_id, hidden, version_number, translation_option for default language,source and order.","value":{"title":"updated article title","content":"Hi this is an API article Sample. This is updated.","html_content":"

Hi this is an API article Sample. This is updated.

","category_id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","hidden":true,"version_number":1,"translation_option":"2","source":"uat","order":0}}}}},"required":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/CreateArticleResponse"},"examples":{"Article Created Successfully":{"summary":"The article has been created under the following category. you can use the article Id to view the article in the portal.","value":{"data":{"id":"a1096061-e842-41fd-9085-494095e401b9","title":"Knowledge bases are much easier to design and edit","content":"Have you ever edited a Wikipedia page? You have to break the flow of text to add tags, and when you want to connect two articles together you have to just hope that nobody changes the other article’s name, lest you end up with a rusty red “dead link.”To be fair,Wikipedia has actually made good strides in making their Wiki software easy to use for anybody, but opening up the editor is still a bit of a shock since you don’t see the familiar webpage you just clicked on. With a knowledge base, what you see is what you get.You don’t have to train anybody on how to add or edit pages because the whole thing is extremely intuitive. Anybody can learn to navigate an edit page in seconds flat.","html_content":null,"category_id":"de104b39-db97-4509-8d4c-deeac74d448b","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","version_number":1,"public_version":1,"latest_version":2,"enable_rtl":false,"hidden":false,"status":0,"version_type":null,"order":0,"created_by":"f11efc6f-e968-4e95-82eb-85ad61559de8","authors":[{"id":"f11efc6f-e968-4e95-82eb-85ad61559de8","first_name":"peter","last_name":"jone","user_description":null,"unique_user_name":"peter-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","profile_logo_cdn_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","is_enterprise_user":false}],"created_at":"2024-06-13T14:30:00","modified_at":"2024-06-13T14:30:00","slug":"Knowledge-bases-are-much-easier-to-design-and edit","is_fall_back_content":false,"description":null,"stale_status":null,"category_type":0,"content_type":null,"is_shared_article":false,"translation_option":0,"url":"https://example.com/v1/docs/en/getting-started","current_workflow_status_id":null,"available_languages":[],"security_visibility":0},"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":{"Article Not Found":{"summary":"Kindly verify the article Id and Langauage code, and peroform the task again.","value":{"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Article not found","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":{"UpdateArticleRequest":{"type":"object","properties":{"title":{"type":"string","description":"The title of the article","nullable":true},"content":{"type":"string","description":"The content of the article, for any Editor type, use this property.","nullable":true},"html_content":{"type":"string","description":"The HTML content of the article. If the editor type is WYSIWYG (HTML), use this property - (This property is deprecated and will be removed in a future version of the API. Kindly use **content** property instead of this.)","nullable":true,"deprecated":true},"category_id":{"type":"string","description":"The ID of the category. If the article has to be moved to another category, enter the desired category ID","nullable":true},"hidden":{"type":"boolean","description":"Visibility status of the article. **true** - Article will be hidden; **false** - Article will be shown"},"version_number":{"type":"integer","description":"The version number of the article to be updated. The latest version is updated by default.","format":"int32","nullable":true},"translation_option":{"type":"string","description":"Translation status of the article. 0 - None, 1 - Needs translation, 2 Translated","nullable":true},"source":{"type":"string","description":"Free text used for future reference","nullable":true},"order":{"type":"integer","description":"To update the position of the article in the category tree. (Default value is 0, and the order starts from 1 when explicitly set or updated).","format":"int32"}},"additionalProperties":false},"CreateArticleResponse":{"type":"object","properties":{"data":{"allOf":[{"$ref":"#/components/schemas/ArticleSimpleDataCustomer"}],"description":"Create article response 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},"ArticleSimpleDataCustomer":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the article","nullable":true,"readOnly":true},"title":{"type":"string","description":"The article title","nullable":true},"public_version":{"type":"integer","description":"The article version number(revision) that is currently published","format":"int32","readOnly":true},"latest_version":{"type":"integer","description":"The latest version number of this article","format":"int32","readOnly":true},"language_code":{"type":"string","description":"The default language code","nullable":true,"deprecated":true},"hidden":{"type":"boolean","description":"Indicates if the article 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}},"order":{"type":"integer","description":"The position of the article inside the parent category","format":"int32"},"slug":{"type":"string","description":"The slug of the article","nullable":true,"readOnly":true},"content_type":{"allOf":[{"$ref":"#/components/schemas/ArticleContentType"}],"description":"The content type of the article: Markdown = 0, Wysiwyg = 1, Block = 2","nullable":true},"translation_option":{"enum":["none","needTranslation","translated","inProgress"],"type":"string","allOf":[{"$ref":"#/components/schemas/LanguageTranslationOption"}],"description":"The translation status of the document.\r\nValid values: 0 - None, 1 - Need Translation, 2 - Translated, 3 - In Progress","x-enumNames":["None","NeedTranslation","Translated","InProgress"],"x-enum-varnames":["None","NeedTranslation","Translated","InProgress"],"x-ms-enum":{"name":"LanguageTranslationOption","modelAsString":true}},"is_shared_article":{"type":"boolean","description":"`True` indicates that the article is shared"},"created_at":{"type":"string","description":"Article created date time","format":"date-time","nullable":true,"readOnly":true},"modified_at":{"type":"string","description":"Article modified date time","format":"date-time","nullable":true,"readOnly":true},"current_workflow_status_id":{"type":"string","description":"Current Workflow status of the article","nullable":true}},"additionalProperties":false,"description":"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."},"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}},"ArticleContentType":{"enum":["markdown","wysiwyg","block"],"type":"string","description":"0 - Markdown; 1 - WYSIWYG(HTML); 2 - Advanced WYSIWYG","x-enumNames":["Markdown","Wysiwyg","Block"],"x-enum-varnames":["Markdown","Wysiwyg","Block"],"x-ms-enum":{"name":"ArticleContentType","modelAsString":true}},"LanguageTranslationOption":{"enum":["none","needTranslation","translated","inProgress"],"type":"string","description":"0 - None, 1 - Needs transation, 2 - Translated, 3 - In progress","x-enumNames":["None","NeedTranslation","Translated","InProgress"],"x-enum-varnames":["None","NeedTranslation","Translated","InProgress"],"x-ms-enum":{"name":"LanguageTranslationOption","modelAsString":true}}},"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"}}}}