# Docs API

**URL:** https://community.onlyoffice.com/c/document-api/39.md

[Latest](https://community.onlyoffice.com/latest.md) · [Categories](https://community.onlyoffice.com/categories.md) · [Tags](https://community.onlyoffice.com/tags.md)

---

## [Read this before creating your first topic Documents API category](https://community.onlyoffice.com/t/read-this-before-creating-your-first-topic-documents-api-category/67)

<div class="topic-metadata">

**Author:** [@system](https://community.onlyoffice.com/u/system)\
**Replies:** 1\
**Last updated:** [26 May 2023 06:44 UTC](https://community.onlyoffice.com/t/read-this-before-creating-your-first-topic-documents-api-category/67 "2023-05-26T06:44:18Z")

</div>

ONLYOFFICE provides open API that exposes the solution functionality, describes the main methods that allow you to interact with different ONLYOFFICE components thus giving you programmatic access to it. ONLYOFFICE Docs…

---

## [OfficeApi's Paragraph throwing an exception when calling Search function](https://community.onlyoffice.com/t/officeapis-paragraph-throwing-an-exception-when-calling-search-function/10691)

<div class="topic-metadata">

**Author:** [@Tarragod](https://community.onlyoffice.com/u/Tarragod)\
**Replies:** 8\
**Last updated:** [14 October 2026 20:18 UTC](https://community.onlyoffice.com/t/officeapis-paragraph-throwing-an-exception-when-calling-search-function/10691 "2026-10-14T20:18:29Z")

</div>

Do you want to: Report a bug Document Server version:8.1.1.26 Additional information: I have a sample .pptx file where I want to write a macro that’ll search a paragraph for a specific word and then highlight the hits…

---

## [One or more required parameter for the config object is not set](https://community.onlyoffice.com/t/one-or-more-required-parameter-for-the-config-object-is-not-set/20814)

<div class="topic-metadata">

**Author:** [@MrChen](https://community.onlyoffice.com/u/MrChen)\
**Replies:** 3\
**Last updated:** [14 October 2026 08:04 UTC](https://community.onlyoffice.com/t/one-or-more-required-parameter-for-the-config-object-is-not-set/20814 "2026-10-14T08:04:19Z")

</div>

windows环境安装完社区版9.4.0，然后进行打开onlyoffice的样例是没有问题的，都可以进行访问， ● http://127.0.0.1:8001/ ● http://127.0.0.1:8001/example/ ● http://127.0.0.1:8001/web-apps/apps/api/documents/api.js 这些都能正常访问。但是接入业务中，就出现如下报错问题： 所有的服务都在本地电脑…

---

## [How to add add Fonts when using DocsAPI with our product](https://community.onlyoffice.com/t/how-to-add-add-fonts-when-using-docsapi-with-our-product/20968)

<div class="topic-metadata">

**Author:** [@jadams](https://community.onlyoffice.com/u/jadams)\
**Replies:** 3\
**Last updated:** [14 October 2026 07:21 UTC](https://community.onlyoffice.com/t/how-to-add-add-fonts-when-using-docsapi-with-our-product/20968 "2026-10-14T07:21:39Z")

</div>

Hello, Does anyone know the best path to supporting additional fonts when using the Docs API? e.g., BC-Sans or Nunito Sans.

---

## [IMPORTRANGE formula bug in spreadsheet](https://community.onlyoffice.com/t/importrange-formula-bug-in-spreadsheet/15087)

<div class="topic-metadata">

**Author:** [@Jimmy0769](https://community.onlyoffice.com/u/Jimmy0769)\
**Replies:** 3\
**Last updated:** [13 October 2026 12:14 UTC](https://community.onlyoffice.com/t/importrange-formula-bug-in-spreadsheet/15087 "2026-10-13T12:14:40Z")

</div>

When I press Enter after entering the formula for the first time, only one cell of data will be filled in. When I click on the formula edit area again and then press Enter, the data filled in the range will be successful…

---

## [Xlsx to PDF conversion issue](https://community.onlyoffice.com/t/xlsx-to-pdf-conversion-issue/20739)

<div class="topic-metadata">

**Author:** [@otovchits](https://community.onlyoffice.com/u/otovchits)\
**Replies:** 4\
**Last updated:** [16 September 2026 10:45 UTC](https://community.onlyoffice.com/t/xlsx-to-pdf-conversion-issue/20739 "2026-09-16T10:45:50Z")

</div>

Hi! I’m using OnlyOffice community edition (docker based, BASE\_VERSION=24.04) and face some conversion issues. the doc i need to convert contains multiple sheets, each such sheet contain footer and header with images i…

---

## [Spreadsheet macro to request cell values-prompt() not working](https://community.onlyoffice.com/t/spreadsheet-macro-to-request-cell-values-prompt-not-working/20510)

<div class="topic-metadata">

**Author:** [@kevinr](https://community.onlyoffice.com/u/kevinr)\
**Replies:** 8\
**Last updated:** [14 September 2026 11:39 UTC](https://community.onlyoffice.com/t/spreadsheet-macro-to-request-cell-values-prompt-not-working/20510 "2026-09-14T11:39:22Z")

</div>

I’m a new OnlyOffice user (previously Excel) and I’m trying to write a macro which prompts the user to provide values for several cells. The prompt() command doesn’t work-nothing pops up to request input values. If I m…

---

## [How to use v9.3 signature field via DocBuilder API?](https://community.onlyoffice.com/t/how-to-use-v9-3-signature-field-via-docbuilder-api/20621)

<div class="topic-metadata">

**Author:** [@therootcompany](https://community.onlyoffice.com/u/therootcompany)\
**Replies:** 1\
**Last updated:** [3 September 2026 11:16 UTC](https://community.onlyoffice.com/t/how-to-use-v9-3-signature-field-via-docbuilder-api/20621 "2026-09-03T11:16:43Z")

</div>

I’m on Document Server 9.4 and I’m trying to use DocBuilder to add the Signature field introduced in 9.3 (for documents that have a variable number of signers). This is how I’m doing it in the docx: let customerSig …

---

## [Different display of a docx file in ms office word and onlyoffice](https://community.onlyoffice.com/t/different-display-of-a-docx-file-in-ms-office-word-and-onlyoffice/20576)

<div class="topic-metadata">

**Author:** [@vig](https://community.onlyoffice.com/u/vig)\
**Replies:** 1\
**Last updated:** [28 August 2026 11:45 UTC](https://community.onlyoffice.com/t/different-display-of-a-docx-file-in-ms-office-word-and-onlyoffice/20576 "2026-08-28T11:45:32Z")

</div>

Hello OnlyOffice team! Environment: onlyoffice/documentserver:9.2.1 (deployed via Docker) We are experiencing rendering differences between ONLYOFFICE and MS Word when working with the same DOCX file. The document layo…

---

## [Convert xlsx with several sheets to pdf](https://community.onlyoffice.com/t/convert-xlsx-with-several-sheets-to-pdf/20575)

<div class="topic-metadata">

**Author:** [@vig](https://community.onlyoffice.com/u/vig)\
**Replies:** 1\
**Last updated:** [27 August 2026 14:10 UTC](https://community.onlyoffice.com/t/convert-xlsx-with-several-sheets-to-pdf/20575 "2026-08-27T14:10:01Z")

</div>

Hello OnlyOffice team! Subject: API Conversion Issue: Complex cross-sheet INDIRECT/ADDRESS formulas result in #VALUE! error (Desktop Editor works correctly) Environment: onlyoffice/documentserver:9.2.1 (deployed via Do…

---

## [Unable to install the ONLYOFFICE inside the Venn platform. I can download it however i am unable to install it, there an error: the parameter is incorrect. what should i do?](https://community.onlyoffice.com/t/unable-to-install-the-onlyoffice-inside-the-venn-platform-i-can-download-it-however-i-am-unable-to-install-it-there-an-error-the-parameter-is-incorrect-what-should-i-do/20147)

<div class="topic-metadata">

**Author:** [@cmiape](https://community.onlyoffice.com/u/cmiape)\
**Replies:** 1\
**Last updated:** [26 June 2026 14:22 UTC](https://community.onlyoffice.com/t/unable-to-install-the-onlyoffice-inside-the-venn-platform-i-can-download-it-however-i-am-unable-to-install-it-there-an-error-the-parameter-is-incorrect-what-should-i-do/20147 "2026-06-26T14:22:22Z")

</div>

Unable to install the ONLYOFFICE inside the Venn platform. I can download it however i am unable to install it, there an error: the parameter is incorrect. what should i do?

---

## [Saving an unedited document](https://community.onlyoffice.com/t/saving-an-unedited-document/8106)

<div class="topic-metadata">

**Author:** [@chundley](https://community.onlyoffice.com/u/chundley)\
**Replies:** 11\
**Last updated:** [2 June 2026 09:41 UTC](https://community.onlyoffice.com/t/saving-an-unedited-document/8106 "2026-06-02T09:41:38Z")

</div>

Question that I just noticed after building this into our application. So in our scenario, a user will choose a prebuild document from a dropdown list and hit the generate document button. This will then open a new wind…

---

## [Cell value not been updated while editing](https://community.onlyoffice.com/t/cell-value-not-been-updated-while-editing/18890)

<div class="topic-metadata">

**Author:** [@humbol](https://community.onlyoffice.com/u/humbol)\
**Replies:** 5\
**Last updated:** [15 April 2026 14:14 UTC](https://community.onlyoffice.com/t/cell-value-not-been-updated-while-editing/18890 "2026-04-15T14:14:06Z")

</div>

Do you want to: Report a bug / how-to question Document Server version: 9.3.1.8 Additional information: Hello, The following code works well generally var sheet = Api.GetActiveSheet(); var cell = sheet.GetActiv…

---

## [How do word comments in review mode display all comments in initial load。](https://community.onlyoffice.com/t/how-do-word-comments-in-review-mode-display-all-comments-in-initial-load/1253)

<div class="topic-metadata">

**Author:** [@jonhus](https://community.onlyoffice.com/u/jonhus)\
**Replies:** 7\
**Last updated:** [6 April 2026 08:49 UTC](https://community.onlyoffice.com/t/how-do-word-comments-in-review-mode-display-all-comments-in-initial-load/1253 "2026-04-06T08:49:48Z")

</div>

The comments in Word will be displayed every time you click on the modified place. Now I want to directly display all the comments on the page when opening the modified file. I don’t know whether onlyOffice supports the …

---

## [When using the automation API to add annotations in OnlyOffice, it works in Word but encounters issues in Excel. The annotations are not bound to the cells. What could be the reason for this?](https://community.onlyoffice.com/t/when-using-the-automation-api-to-add-annotations-in-onlyoffice-it-works-in-word-but-encounters-issues-in-excel-the-annotations-are-not-bound-to-the-cells-what-could-be-the-reason-for-this/18897)

<div class="topic-metadata">

**Author:** [@dingnan](https://community.onlyoffice.com/u/dingnan)\
**Replies:** 3\
**Last updated:** [1 April 2026 14:05 UTC](https://community.onlyoffice.com/t/when-using-the-automation-api-to-add-annotations-in-onlyoffice-it-works-in-word-but-encounters-issues-in-excel-the-annotations-are-not-bound-to-the-cells-what-could-be-the-reason-for-this/18897 "2026-04-01T14:05:36Z")

</div>

The content within the blue box was added through OnlyOffice, while the content within the red box was added through Automation API

---

## [The xlsx file contains.The PNG image display has an issue](https://community.onlyoffice.com/t/the-xlsx-file-contains-the-png-image-display-has-an-issue/18939)

<div class="topic-metadata">

**Author:** [@zhongjinfu\_new](https://community.onlyoffice.com/u/zhongjinfu_new)\
**Replies:** 1\
**Last updated:** [25 March 2026 13:02 UTC](https://community.onlyoffice.com/t/the-xlsx-file-contains-the-png-image-display-has-an-issue/18939 "2026-03-25T13:02:52Z")

</div>

The PNG image display shows double images Source file display is normal

---

## [Download Security](https://community.onlyoffice.com/t/download-security/18722)

<div class="topic-metadata">

**Author:** [@Mukesh](https://community.onlyoffice.com/u/Mukesh)\
**Replies:** 4\
**Last updated:** [25 March 2026 11:36 UTC](https://community.onlyoffice.com/t/download-security/18722 "2026-03-25T11:36:55Z")

</div>

Concern Regarding Public Accessibility of OnlyOffice Callback URL The OnlyOffice callback URL is publicly accessible, and I’m wondering whether we should drop the cache immediately after saving the file. When the OnlyO…

---

## [集成方案错误，无法打开指定文件内容](https://community.onlyoffice.com/t/topic/8680)

<div class="topic-metadata">

**Author:** [@xinxinqian](https://community.onlyoffice.com/u/xinxinqian)\
**Replies:** 12\
**Last updated:** [23 March 2026 08:56 UTC](https://community.onlyoffice.com/t/topic/8680 "2026-03-23T08:56:53Z")

</div>

---

## [onlyOffice接入遇到一个问题，他会自动滚动到iframe所在位置](https://community.onlyoffice.com/t/onlyoffice-iframe/18867)

<div class="topic-metadata">

**Author:** [@wanfeng](https://community.onlyoffice.com/u/wanfeng)\
**Replies:** 1\
**Last updated:** [20 March 2026 15:32 UTC](https://community.onlyoffice.com/t/onlyoffice-iframe/18867 "2026-03-20T15:32:49Z")

</div>

而我不需要他这个特性，如何解决？ 版本是7.1.1目前尝试的办法包括： 1.设置tabindex为-1，scrolling为no 2.父容器设置样overflow: hidden;scroll-behavior: auto; 3.调用blurFocus消息

---

## [Programmatically search and select sentences in Presentation](https://community.onlyoffice.com/t/programmatically-search-and-select-sentences-in-presentation/18806)

<div class="topic-metadata">

**Author:** [@Mustafa](https://community.onlyoffice.com/u/Mustafa)\
**Replies:** 1\
**Last updated:** [17 March 2026 11:49 UTC](https://community.onlyoffice.com/t/programmatically-search-and-select-sentences-in-presentation/18806 "2026-03-17T11:49:25Z")

</div>

Hi, I m looking for ways to programmatically search and select a sentence in the docs, pdf, and slide. I found some methods works with pdf and docx but i cannot find any methods for slides. SearchNext Search is not work…

---

## [Docx to pdf issue and html to pdf conversion issue](https://community.onlyoffice.com/t/docx-to-pdf-issue-and-html-to-pdf-conversion-issue/15549)

<div class="topic-metadata">

**Author:** [@oswas](https://community.onlyoffice.com/u/oswas)\
**Replies:** 14\
**Last updated:** [12 March 2026 17:44 UTC](https://community.onlyoffice.com/t/docx-to-pdf-issue-and-html-to-pdf-conversion-issue/15549 "2026-03-12T17:44:26Z")

</div>

We are using community version of only office API.When uploading a .docx file and converting to PDF via the OnlyOffice conversion tool, the output PDF sometimes contains corrupted or unreadable content. This happens eve…

---

## [How show headings (table of content) by default?](https://community.onlyoffice.com/t/how-show-headings-table-of-content-by-default/11927)

<div class="topic-metadata">

**Author:** [@leandro](https://community.onlyoffice.com/u/leandro)\
**Replies:** 8\
**Last updated:** [6 March 2026 08:05 UTC](https://community.onlyoffice.com/t/how-show-headings-table-of-content-by-default/11927 "2026-03-06T08:05:33Z")

</div>

I want to know if it is possible to show up the headings by default when open the document

---

## [I cann,t get outline level](https://community.onlyoffice.com/t/i-cann-t-get-outline-level/17525)

<div class="topic-metadata">

**Author:** [@yihong](https://community.onlyoffice.com/u/yihong)\
**Replies:** 12\
**Last updated:** [4 March 2026 08:06 UTC](https://community.onlyoffice.com/t/i-cann-t-get-outline-level/17525 "2026-03-04T08:06:13Z")

</div>

I uploaded a template document where the paragraph headings already have custom formatting applied. The outline levels in the paragraph management section cannot be modified, and I am unable to retrieve the outline level…

---

## [Problem with SetSort](https://community.onlyoffice.com/t/problem-with-setsort/3108)

<div class="topic-metadata">

**Author:** [@PMSphere](https://community.onlyoffice.com/u/PMSphere)\
**Replies:** 3\
**Last updated:** [26 February 2026 09:27 UTC](https://community.onlyoffice.com/t/problem-with-setsort/3108 "2026-02-26T09:27:18Z")

</div>

Hello I’m starting with macro on OnlyOffice. I have some test well working. But I’m blocked with SetSort. I would to order a range of 3 column and 4 rows. I wrote : (function() { var oWorksheet = Api.GetActiveSh…

---

## [Content control issues](https://community.onlyoffice.com/t/content-control-issues/18406)

<div class="topic-metadata">

**Author:** [@Avi\_J](https://community.onlyoffice.com/u/Avi_J)\
**Replies:** 13\
**Last updated:** [16 February 2026 13:54 UTC](https://community.onlyoffice.com/t/content-control-issues/18406 "2026-02-16T13:54:12Z")

</div>

I am using the ONLYOFFICE editor to wrap the entire document inside a content control so that I can make changes to the document programmatically in the future using those content controls. However, because of this, the…

---

## [Track changes behaviour issues](https://community.onlyoffice.com/t/track-changes-behaviour-issues/18474)

<div class="topic-metadata">

**Author:** [@Avi\_J](https://community.onlyoffice.com/u/Avi_J)\
**Replies:** 1\
**Last updated:** [16 February 2026 13:52 UTC](https://community.onlyoffice.com/t/track-changes-behaviour-issues/18474 "2026-02-16T13:52:39Z")

</div>

I want to confirm the following: If Track Changes is enabled at all times, and I delete text from the document using the ONLYOFFICE automation API (for example, through callCommand), will the deleted text appear as a tr…

---

## [How to scroll the screen to the desired position](https://community.onlyoffice.com/t/how-to-scroll-the-screen-to-the-desired-position/731)

<div class="topic-metadata">

**Author:** [@xcar](https://community.onlyoffice.com/u/xcar)\
**Replies:** 3\
**Last updated:** [24 November 2021 11:45 UTC](https://community.onlyoffice.com/t/how-to-scroll-the-screen-to-the-desired-position/731 "2021-11-24T11:45:20Z")

</div>

please. How to scroll the screen to the desired position? I use “oworksheet. Setactive();” and “oRange.Select();” ,The cell was activated successfully, but the screen was not scrolled. the sheetlabel color is also wr…

---

## [How to get the comments data added in the document in onlyoffice document editor?](https://community.onlyoffice.com/t/how-to-get-the-comments-data-added-in-the-document-in-onlyoffice-document-editor/2075)

<div class="topic-metadata">

**Author:** [@bipana.shrestha](https://community.onlyoffice.com/u/bipana.shrestha)\
**Replies:** 5\
**Last updated:** [9 February 2026 09:35 UTC](https://community.onlyoffice.com/t/how-to-get-the-comments-data-added-in-the-document-in-onlyoffice-document-editor/2075 "2026-02-09T09:35:38Z")

</div>

I need to save the comment made on the document in the database but I am finding no way to get the comment text/data after the comment is made, no events/methods related to it. I found nothing in the document server tab.…

---

## [word文档如何通过API进行上下翻页或者跳转到指定页面？](https://community.onlyoffice.com/t/word-api/15568)

<div class="topic-metadata">

**Author:** [@hzj](https://community.onlyoffice.com/u/hzj)\
**Replies:** 10\
**Last updated:** [3 February 2026 08:42 UTC](https://community.onlyoffice.com/t/word-api/15568 "2026-02-03T08:42:21Z")

</div>

word文档如何通过API进行上下翻页或者跳转到指定页面？

---

## [Dragging the width of cells,sheet suddenly disappeared](https://community.onlyoffice.com/t/dragging-the-width-of-cells-sheet-suddenly-disappeared/18143)

<div class="topic-metadata">

**Author:** [@KongQingOu](https://community.onlyoffice.com/u/KongQingOu)\
**Replies:** 1\
**Last updated:** [29 January 2026 10:48 UTC](https://community.onlyoffice.com/t/dragging-the-width-of-cells-sheet-suddenly-disappeared/18143 "2026-01-29T10:48:52Z")

</div>

version:7.2 When operating on one of the sheets in the spreadsheet (dragging the width of cells left and right, clicking on cells), that sheet suddenly disappeared.

[Next page](https://community.onlyoffice.com/c/document-api/39.md?page=1)
