Get Spreadsheet Metadata - BlinkOps Documentation

Parameters
Example Output
Workflow Library Example

Retrieve metadata information for a Lark spreadsheet, including sheet list and properties. One of the following scopes is required for using this action:

View, comment, edit, and manage all files in My Space
View, comment, and download all files in My Space
View, comment, edit, and manage Sheets
View, comment, and export Sheets

External DocumentationTo learn more, visit the Lark documentation.

Parameters

Parameter	Description
Spreadsheet Token	The token of the spreadsheet. This token can be found in the spreadsheet URL - `https://sample.larksuite.com/sheets/{SPREADSHEET_TOKEN}`. For example, if the sheet URL is `https://sample.larksuite.com/sheets/shtcnmBAyGehy8`, the token is: `shtcnmBAyGehy8`.

Example Output

{
	"code": 0,
	"msg": "Success",
	"data": {
		"properties": {
			"title": "",
			"ownerUser": 0,
			"sheetCount": 0,
			"revision": 0
		},
		"sheets": [
			{
				"sheetId": "***",
				"title": "***",
				"index": 0,
				"rowCount": 0,
				"columnCount": 0,
				"frozenColCount": 0,
				"frozenRowCount": 0,
				"merges": [
					{
						"columnCount": 0,
						"rowCount": 0,
						"startColumnIndex": 0,
						"startRowIndex": 0
					}
				],
				"protectedRange": [
					{
						"dimension": {
							"endIndex": 0,
							"majorDimension": "ROWS",
							"sheetId": "***",
							"startIndex": 0
						},
						"protectId": "***",
						"sheetId": "***",
						"lockInfo": "***"
					}
				]
			},
			{
				"blockInfo": {
					"blockToken": "***",
					"blockType": "***"
				},
				"columnCount": 0,
				"frozenColCount": 0,
				"frozenRowCount": 0,
				"index": 0,
				"rowCount": 0,
				"sheetId": "***",
				"title": "*** "
			}
		],
		"spreadsheetToken": "***"
	}
}