Feishu Node

Actions61

Overview

This n8n custom node interacts with the Feishu (Lark) 多维表格 (Bitable) service to "列出字段" (List Fields) for a specified table. It allows users to retrieve metadata about all fields (columns) in a given Bitable, optionally filtered by view and paginated. This is useful for automation scenarios where you need to dynamically understand or process the structure of a Feishu Bitable, such as generating dynamic forms, mapping data, or syncing schemas between systems.

Example use cases:

Automatically mapping incoming data to Bitable columns.
Generating reports or dashboards based on table schema.
Validating or transforming data before inserting into a Bitable.

Properties

Name	Type	Meaning
多维表格 Token	string	The unique identifier (token) for the Bitable App. Required for authentication and API access.
多维表格 ID	string	The unique identifier for the specific Bitable table whose fields are to be listed.
视图 ID	string	The unique identifier for a specific view within the Bitable. Optional; can be used to filter fields by view context.
是否数组形式返回	boolean	Whether to return text fields as arrays. If true, text fields will be returned in array format.
分页标记	string	Pagination token. Leave empty for the first request; use the returned value from previous responses to fetch subsequent pages of results.
分页大小	number	Number of items per page. Controls how many fields are returned in one response. Default is 20.

Output

The node outputs an array of JSON objects, each representing a field (column) in the specified Bitable. The exact structure depends on the Feishu API, but typically includes:

[
  {
    "field_id": "string",
    "field_name": "string",
    "type": "string",
    "property": { /* object with field-specific properties */ },
    // ...other metadata fields
  }
]

If an error occurs and "Continue On Fail" is enabled, the output will include an object like:

{
  "error": "Error message"
}

Dependencies

Feishu (Lark) API: Requires valid credentials (feishuCredentialsApi) configured in n8n.
Environment: No special environment variables required beyond standard n8n credential setup.

Troubleshooting

Missing Credentials: If the Feishu credentials are not set up or invalid, the node will fail with an authentication error.
Invalid Table/View IDs: Supplying incorrect 多维表格 ID or 视图 ID will result in API errors indicating resource not found.
Pagination Issues: Not handling pagination tokens correctly may result in incomplete field listings.
Common Error Messages:
- 未实现方法: bitable.bitable:table:field:list: Indicates that the requested operation is not implemented—check if the resource/operation names are correct.
- NodeApiError: Usually indicates an issue with the API call (e.g., bad request, unauthorized). Check the error details for more information.