Lark Base icon

Lark Base

Interact with LarkBase API

Actions11

Record → Search Records

AI-generated

Overview

This node interacts with the LarkBase API to search records within a specified base and table. It allows users to perform complex searches on records by providing a JSON request body that defines the search criteria. This is useful for scenarios where you need to filter or query records based on specific conditions, such as retrieving all records that match certain field values or criteria in a LarkBase table.

Use Case Examples

  1. Search for records in a LarkBase table where a specific field matches a given value.
  2. Retrieve records that meet multiple conditions using a JSON query body.

Properties

Name Meaning
Base ID The identifier of the LarkBase base where the table resides. Required to specify the context for the record search.
Table ID The identifier of the table within the base where the records are searched. Required to specify which table to query.
Request Body A JSON object defining the search criteria and parameters for querying records. This allows for flexible and detailed search queries.

Output

JSON

  • json - The JSON response from the LarkBase API containing the search results of records.

Dependencies

  • LarkBase API access with valid credentials including app ID and app secret.

Troubleshooting

  • Ensure that the Base ID and Table ID are correctly specified and exist in your LarkBase environment.
  • The Request Body must be a valid JSON object matching the expected schema for the LarkBase search API; invalid JSON or incorrect structure will cause errors.
  • Authentication errors may occur if the API credentials are missing or invalid; verify that the credentials are correctly configured.
  • Common error messages include 'Get tenant_token failed' indicating issues with obtaining the necessary access token, and 'Unknown operation' if the operation parameter is incorrect.

Links

  • LarkBase API - Search Records - Official documentation for the LarkBase API endpoint to search records, detailing request and response formats.

Discussion