Skip to main content

Get Lark Base field

Sophie avatar
Written by Sophie
Updated this week

Definition and Usage

Retrieve all fields from a specified table within the Lark Base. Use this action after you have connected to Lark Base. You can locate the target table either by its name or by its unique ID. The command returns the table’s fields so you can reference them later in your workflow.

Parameter Values

Input Parameters

Parameter Name

Description

Possible Values

Required

Options / Notes

Lark Base

The connected Lark Base instance to use.

Lark Base object

Yes

Must be created by Connect Lark Base; ensure the connection is active.

Locating mode

How to specify the target table.

By name, By ID

Yes

Choose By name when table names are stable; choose By ID for guaranteed precision.

Data table name

The name of the table whose fields you want to retrieve.

Text

Conditionally

Required if Locating mode = By name; must match exactly as in Lark Base.

Data table ID

The unique ID of the table whose fields you want to retrieve.

Text

Conditionally

Required if Locating mode = By ID; copy from Lark Base to avoid typos.

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 list you can store for later steps. Each item represents a field from the table and includes its identifier and display name. Use this list to select fields dynamically in subsequent actions, validate field existence, or map data to specific columns.

Using Variables in Conditions

You can pass values from earlier steps into this command to make it dynamic. For example, use a variable to supply the table name or ID selected earlier in the workflow. If the UI shows {x} next to a field, it indicates that the field accepts variables. Combine this with conditions to choose the locating mode and target table at runtime based on previous results.

Notes

  • Connect to Lark Base before using this command; the Lark Base object must be valid.

  • Choose Locating mode carefully: By ID is less error-prone than By name when multiple tables have similar names.

  • Ensure the specified table exists and is accessible to the connected account; insufficient permissions will cause errors.

  • When using By name, avoid leading/trailing spaces and confirm exact casing as used in Lark Base.

  • Use the produced field list to programmatically reference columns, reducing hard-coded field names in your workflow.

Did this answer your question?