Lark Base

Lark Base Management

Actions21

Overview

The "List Records" operation for the "Record" resource in this node allows users to retrieve multiple records from a specified table within a bitable app on the Lark platform. This operation is useful when you want to fetch and process data stored in Lark's bitable tables, such as retrieving all entries in a project management table, customer database, or inventory list.

Practical examples include:

Extracting all task records from a project management table to generate reports.
Fetching customer contact details stored in a bitable for integration with other systems.
Listing inventory items to synchronize stock levels with an external system.

Properties

Name	Meaning
Authentication	Method of authentication to use: either "Tenant Token" or "OAuth2".
App Token	The unique identifier (app_token) of the bitable app from which to list records.
Table Id	The identifier of the specific table within the bitable app to query records from.
Options	Additional options for the request. Currently supports:
- Use Custom Body	Boolean flag indicating whether to send a custom request body instead of default parameters.

Output

The output of this operation is a JSON object containing the list of records retrieved from the specified table. Each record typically includes fields corresponding to the columns defined in the bitable, such as text, numbers, dates, or other supported data types.

If the node supports binary data output (not explicitly shown here), it would represent attachments or files associated with records, but based on the provided code and properties, the primary output is structured JSON data representing the records.

Dependencies

Requires access to the Lark Suite API, specifically the bitable endpoints.
Requires either a Tenant Token or OAuth2 credentials for authentication.
The base URL for API requests is https://open.larksuite.com/open-apis.
The user must provide valid app_token and table_id values to identify the target bitable app and table.

Troubleshooting

Invalid App Token or Table ID: If the provided app_token or table_id is incorrect or does not exist, the API will return errors. Verify these IDs are correct and correspond to accessible resources.
Authentication Errors: Using invalid or expired tokens will cause authentication failures. Ensure that the selected authentication method is properly configured and tokens are valid.
Permission Issues: The authenticated user or token must have sufficient permissions to read records from the specified bitable app and table.
Custom Body Usage: If "Use Custom Body" is enabled but the custom body is malformed or incomplete, the request may fail. Validate the custom body format before sending.