Lark Base V2 icon

Lark Base V2

Get and create data in Lark Base
Join our community

Actions2

Overview

The "Get Many" operation of the Lark Base V2 node allows users to retrieve multiple records from a specified table within a Lark Base application. This operation is useful for scenarios where you need to fetch bulk data entries, such as generating reports, syncing data with other systems, or performing batch analysis on records stored in Lark Base tables.

For example, you might use this node to:

  • Retrieve all customer records that meet certain filter criteria.
  • Fetch paginated results from a large dataset for processing in workflows.
  • Sort and filter records dynamically based on user input or workflow conditions.

Properties

Name Meaning
App Token The app_token of the Lark Base application, used to identify which app's data to access.
Table ID The unique identifier of the table from which to retrieve records.
Options A collection of optional parameters to customize the query:
  View ID The unique identifier of a base view to filter or scope the records returned.
  Filter A filter expression to narrow down records, e.g., AND(CurrentValue.[Height]>180, CurrentValue.[Weight]>150).
  Sort A sort expression to order the results, e.g., ["fieldName1 DESC","fieldName2 ASC"].
  Field Names Specifies which fields to return in the response, e.g., ["fieldName1"].
  Page Token A token to specify the page of results to retrieve, supporting pagination.
  Page Size Number of records to return per page, with a maximum of 500. Defaults to 20.

Output

The output JSON contains the retrieved records from the specified table. Each record includes its fields and associated data as returned by the Lark Base API. The structure typically looks like:

{
  "records": [
    {
      "recordId": "string",
      "fields": {
        "fieldName1": "value1",
        "fieldName2": "value2"
      }
    },
    ...
  ],
  "pageToken": "string" // token for next page if more records exist
}

This output can be used downstream in workflows for further processing, filtering, or integration with other services.

The node does not output binary data for this operation.

Dependencies

  • Requires an API key credential (an API authentication token) for Lark Base to authenticate requests.
  • The node internally obtains a tenant access token by calling Lark's internal authentication endpoint using the provided credentials.
  • Network access to https://open.larksuite.com/open-apis is required.
  • No additional environment variables are needed beyond the configured credentials.

Troubleshooting

  • Failed to get tenant access token: This error indicates issues with the provided API credentials (app ID and secret). Verify that the credentials are correct and have sufficient permissions.
  • Invalid JSON in records parameter: Although this applies to the create operation, it may appear if JSON inputs are malformed. Ensure JSON inputs are valid.
  • Records must be an array: For create operations, but if encountered here, check that any JSON inputs are arrays as expected.
  • API rate limits or network errors: If requests fail intermittently, check network connectivity and API usage limits.
  • Pagination issues: If using page tokens, ensure tokens are correctly passed between executions to avoid missing or repeating records.

Links and References

Discussion