Lark Base icon

Lark Base

Get data from Lark Base
Join our community

Actions2

Overview

The "Get Many" operation of the Lark Base node retrieves multiple records from a specified table within a Lark Base application. This operation is useful when you need to fetch bulk data entries from a database-like table, optionally filtered, sorted, or paginated according to your needs.

Common scenarios include:

  • Extracting a list of customer records for reporting or analysis.
  • Fetching filtered datasets based on specific criteria (e.g., height and weight conditions).
  • Retrieving paginated results to process large datasets in manageable chunks.

For example, you might use this node to get all employee records where the height is greater than 180 cm and weight is above 150 lbs, sorted by last name descending, returning only certain fields like name and email.

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.
  Filter A filter expression to limit records returned, e.g., AND(CurrentValue.[Height]>180, CurrentValue.[Weight]>150).
  Sort Sort expression as an array of strings indicating field names and order, e.g., ["fieldName1 DESC","fieldName2 ASC"].
  Field Names Specifies which fields to return in the response, e.g., ["fieldName1"].
  Page Token Identifier for pagination to continue fetching from a specific page.
  Page Size Number of records to return per page, with a maximum of 500. Default is 20.

Output

The output JSON contains the retrieved records from the specified table. Each record includes its fields and metadata as provided by the Lark Base API. The structure typically includes:

  • An array of record objects, each representing a row in the table.
  • Pagination tokens if more records are available beyond the current page.

This node does not output binary data.

Dependencies

  • Requires an API key credential for authenticating with the Lark Base API.
  • The node internally obtains a tenant access token by making a POST request to Lark's authentication endpoint using the stored API credentials.
  • Network access to https://open.larksuite.com/open-apis is required.

Troubleshooting

  • Failed to get tenant access token: This error occurs if the API credentials are invalid or expired. Verify that the API key and secret are correct and have sufficient permissions.
  • No valid access token returned: Indicates an issue with the authentication response. Check network connectivity and API service status.
  • Invalid filter or sort expressions: Ensure that filter and sort syntax matches the expected format by Lark Base API.
  • Pagination issues: If using page tokens, ensure they are correctly passed and valid; otherwise, no further pages will be returned.

Links and References

Discussion