Overview - DingTalk Help Center

DingTalk Spreadsheet OpenAPI provides a set of RESTful interfaces that allow developers to operate DingTalk Spreadsheet documents programmatically. Use these APIs to automate data read/write operations, manage worksheets, look up cells, lock ranges, and more. They are suitable for scenarios such as data synchronization, report generation, and office automation.

Open API overview

DingTalk Spreadsheet provides a rich set of open APIs. Choose the APIs that fit your business needs.

Worksheet

API	Description	Version
Create a worksheet	Create a new worksheet in a spreadsheet document.	New
Delete a worksheet	Delete a worksheet from a spreadsheet.	New
Get a worksheet	Get the properties of a worksheet.	New
Update a worksheet	Modify the meta attributes of a specified worksheet in a DingTalk Spreadsheet.	New
Get all worksheets	Get information about all worksheets in a specified spreadsheet.	New

Rows and columns

API	Description	Version
Delete Record	Delete the specified records.	New
Delete Column	Delete the specified columns.	New
Set row height automatically	Automatically adjust the height of a specified record in a DingTalk Spreadsheet based on the given font size, so that the content is fully displayed.	New
Batch set column widths	Set the widths of multiple consecutive columns starting from a specified column in a DingTalk Spreadsheet at once.	New
Batch set row heights	Set the heights of multiple consecutive records starting from a specified record in a DingTalk Spreadsheet at once.	New
Append records to a worksheet	Append multiple records of data to the end of existing data in a worksheet.	New
Hide or show records	Hide or show records.	New
Hide or show columns	Hide or show columns.	New
Insert records above a specified record	Insert multiple records above a specified record.	New
Insert columns to the left of a specified column	Insert multiple columns to the left of a specified column.	New

Cell range

API	Description	Version
Merge Cells	Merge multiple cells in a specified range of a DingTalk Spreadsheet into one.	New
Insert a Dropdown List	Set Dropdown List options for a specified cell range in a DingTalk Spreadsheet.	New
Delete a Dropdown List	Remove the Dropdown List configuration set for a specified cell range in a DingTalk Spreadsheet.	New
Get a cell range	Get cell properties.	New
Update a cell range	Update cell information.	New
Find a cell in a worksheet	Find the next cell that matches a given string based on the specified criteria.	New
Find all matching cells	Search for cells containing the target text in a specified worksheet and return a list of matching cell positions.	New
Clear data in a cell range	Clear the data in a cell range, excluding formatting.	New
Clear all content in a cell range	Clear all content in a cell range, including formatting.	New

Conditional Formatting

API	Description	Version
Create a Conditional Formatting rule	Create a Conditional Formatting rule in a specified worksheet of a DingTalk Spreadsheet.	New

Filter

API	Description	Version
Create a Filter	Create a global Filter on a specified worksheet in a DingTalk Spreadsheet and define the Filter range.	New
Update a Filter	Batch update Filters for multiple columns in a global Filter at once.	New
Delete a Filter	Delete the global Filter on a specified worksheet, so that all records hidden by the Filter are displayed again.	New
Get a Filter	Query the currently active global Filter information on a specified worksheet.	New
Sort within a Filter	Sort data within the global Filter range by a specified column in ascending or descending order.	New
Set Filter criteria	Set or update Filter criteria for a specified column in a global Filter.	New
Delete Filter criteria	Clear the Filter criteria of a specified column in a global Filter, so that the column no longer participates in Filter calculation.	New

Filter View

API	Description	Version
Create a Filter View	Create a Filter View on a specified worksheet in a DingTalk Spreadsheet, and specify the View name and Filter range.	New
Update a Filter View	Update the name, range, or Filter criteria of a specified Filter View.	New
Delete a Filter View	Delete a Filter View and all its Filter criteria on a specified worksheet.	New
Get the list of Filter Views	Get the list of all Filter Views on a specified worksheet.	New
Set Filter View criteria	Set or update Filter criteria for a column in a specified Filter View.	New
Delete Filter View criteria	Clear the Filter criteria of a column in a specified Filter View, so that the column no longer participates in Filter calculation.	New

Floating image

API	Description	Version
Create a floating image	Get the list of all floating images in a specified worksheet of a DingTalk Spreadsheet.	New
Update a floating image	Update the properties of an existing floating image in a DingTalk Spreadsheet.	New
Delete a floating image	Delete a floating image from a specified worksheet in a DingTalk Spreadsheet.	New

Glossary

workbookId

The unique identifier of a spreadsheet file. It is the nodeId (dentryUuid) returned by the Knowledge Base API, and can also be obtained from the spreadsheet URL. Obtain it in one of the following ways:

Method 1: Get it from the spreadsheet URL.
Method 2: Get it from the document information.
Method 3: Get it through the Knowledge Base API. Call the Get a node or Create a Knowledge Base document API. The returned nodeId (dentryUuid) is the workbookId.

sheetId

The ID or name of a worksheet. Get it through the Get all worksheets API, or pass the worksheet title directly.

rangeAddress

The cell range address, using A1 notation.

operatorId

The unionId of the operator, used to identify the user performing the action and to verify permissions.

​Open API overview

​Worksheet

​Rows and columns

​Cell range

​Conditional Formatting

​Filter

​Filter View

​Floating image

​Glossary

​workbookId

​sheetId

​rangeAddress

​operatorId