Lark Base icon

Lark Base

Lark Base Management

Overview

The node provides access to Lark Suite's App information via its API. Specifically, the "Get App Information" operation retrieves details about a particular app identified by its app token. This is useful for workflows that need to verify app metadata, check app status, or fetch configuration details programmatically.

Common scenarios include:

  • Automating app management tasks within Lark Suite.
  • Integrating app data retrieval into broader automation workflows.
  • Validating app tokens before performing further operations.

Example: A workflow could use this node to fetch app details and then conditionally proceed based on the app's properties or status.

Properties

Name Meaning
Authentication Method of authenticating API requests. Options: Tenant Token, OAuth2
App Token The unique identifier (token) of the bitable app to retrieve information for. Can be selected from a list or entered as an ID string matching [a-zA-Z0-9]+.
Options Additional optional settings:
- Use Custom Body (boolean): Whether to send a custom request body instead of default

Output

The node outputs JSON data containing the app information retrieved from the Lark Suite API. The structure typically includes fields describing the app's metadata such as its name, ID, status, permissions, and other relevant attributes defined by the API response.

No binary data output is indicated.

Dependencies

  • Requires authentication credentials: either a Tenant Token or OAuth2 token for Lark Suite API access.
  • The node communicates with the Lark Suite Open APIs at https://open.larksuite.com/open-apis.
  • Proper configuration of these credentials in n8n is necessary for successful API calls.

Troubleshooting

  • Invalid App Token: If the app token does not match the required pattern ([a-zA-Z0-9]+), the node will reject it. Ensure the token is correct and properly formatted.
  • Authentication Errors: Using incorrect or expired credentials will cause authentication failures. Verify that the Tenant Token or OAuth2 token is valid and has sufficient permissions.
  • API Connectivity Issues: Network problems or incorrect base URL configurations can prevent communication with the Lark Suite API.
  • Custom Body Usage: Enabling "Use Custom Body" without providing a valid body may cause request errors. Use this option only if you intend to customize the request payload.

Links and References

Discussion