Skip to main content

Get Lark sheet

Sophie avatar
Written by Sophie
Updated this week

Definition and Usage

Connect to a Lark Spreadsheet for automation. Use this command to authenticate with Lark using an access token and target a specific spreadsheet via its URL. The command establishes a connection and prepares the sheet object for use in later steps (such as reading or writing data).

Parameter Values

Input Parameters

Parameter Name

Description

Possible Values

Required

Options / Notes

Access token

Authenticates your connection to Lark to access the spreadsheet.

Any valid Lark API access token

Yes

Ensure the token is active and has permissions for the target sheet; store securely.

Lark Sheets URL

The direct URL to the target Lark spreadsheet.

Full Lark Sheets URL

Yes

Copy from the browser address bar; use the exact sheet URL you intend to automate.

Advanced Settings

No advanced settings available.

Error Handling

Parameter Name

Description

Throw error & stop

When an error occurs, the action will stop execution.

Retry command

The action retries the command if an error occurs.

Ignore error & continue

The action ignores the error and continues workflow execution.

Variables Produced

This action produces a sheet object you can reference in subsequent steps to interact with the same Lark spreadsheet. Use it to pass the connected sheet to actions that read, write, or update content within that spreadsheet.

Using Variables in Conditions

You can pass dynamic values from earlier steps into this command. For example, supply an access token retrieved from a secure store or a URL determined at runtime. If the UI marks a field with {x}, it indicates the field supports variables. In typical workflows, you set these fields using variables so the same automation can target different spreadsheets or accounts without editing the command each time.

Notes

  • Ensure your access token has sufficient permissions to view/edit the target spreadsheet.

  • The Lark Sheets URL must be accessible from the environment where the automation runs.

  • If the token is expired or the URL is invalid, the command will fail; use appropriate error handling.

  • Use the produced sheet object in later steps to avoid reconnecting repeatedly within the same workflow.

Did this answer your question?