> ## Documentation Index
> Fetch the complete documentation index at: https://docs.blinkops.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Spreadsheet Metadata

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`

<Note>
  External Documentation

  To learn more, visit the [Lark documentation](https://open.larksuite.com/document/server-docs/docs/sheets-v3/spreadsheet/obtain-spreadsheet-metadata).
</Note>

## Parameters

<div className="integrations-table">
  | Parameter         | Description                                                                                                                                                                                                                                                                              |
  | ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | Spreadsheet Token | The token of the spreadsheet.<br /><br />This token can be found in the spreadsheet URL - `https://sample.larksuite.com/sheets/{SPREADSHEET_TOKEN}`.<br /><br />For example, if the sheet URL is `https://sample.larksuite.com/sheets/shtcnmBA*yGehy8`, the token is: `shtcnmBA*yGehy8`. |
</div>

## Example Output

```json theme={"dark"}
{
	"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": "***"
	}
}
```

## Workflow Library Example

[Get Spreadsheet Metadata with Lark and Send Results Via Email](https://library.blinkops.com/workflows/get-spreadsheet-metadata-with-lark-and-send-results-via-email)

<div className="iframe-wrapper">
  <div className="iframe-media">
    <img src="https://mintcdn.com/blinkops-2/ojHYuDeYX5FWuN8a/img/Icons/play-box.svg?fit=max&auto=format&n=ojHYuDeYX5FWuN8a&q=85&s=b8af968e71438a9499c3223c9bd29fb2" alt="Workflow Library" width="16" height="16" data-path="img/Icons/play-box.svg" />

    Preview this Workflow on desktop
  </div>

  <iframe className="iframe" src="https://library.blinkops.com/workflows/get-spreadsheet-metadata-with-lark-and-send-results-via-email/canvas" />
</div>