Feishu Node

Actions61

Overview

This node interacts with the Feishu (Lark) 云文档 (Cloud Document) service to retrieve all content blocks from a specified document. It is particularly useful for workflows that need to extract, analyze, or process structured content from Feishu documents—such as reporting, migration, or integration with other systems.

Practical examples:

Extracting all text, images, and tables from a Feishu document for backup or analysis.
Synchronizing Feishu document content with another knowledge base or database.
Automating content review processes by fetching document blocks for further processing.

Properties

Name	Type	Meaning
文档 ID	String	The unique identifier of the document whose blocks are to be retrieved.
分页大小	Number	Page size for pagination; maximum value is 500. Determines how many blocks are fetched per request.
分页标记	String	Pagination token. Leave empty for the first request (starts from the beginning). Use the returned token for subsequent requests to fetch more.
文档版本	Number	Document version to query. `-1` means the latest version.
用户 ID 类型	Options	Type of user ID used in the request. Options: Open_id, Union_id, User_id.

Output

The node outputs an array of objects under the json field. Each object represents a block from the specified Feishu document. The exact structure of each block depends on the Feishu API but typically includes details such as block type, content, block ID, and possibly metadata like parent-child relationships.

If an error occurs and "Continue On Fail" is enabled, the output will include an object with an error property describing the issue.

Example output:

[
  {
    "json": {
      "block_id": "blk_12345",
      "block_type": "text",
      "content": "This is a paragraph.",
      // ...other block properties
    }
  },
  {
    "json": {
      "block_id": "blk_67890",
      "block_type": "image",
      "content": {
        "url": "https://example.com/image.png"
      }
      // ...other block properties
    }
  }
]

If an error occurs:

{
  "json": {
    "error": "Error message here"
  }
}

Dependencies

Feishu API access: Requires valid Feishu credentials (feishuCredentialsApi) configured in n8n.
External Service: Access to the Feishu Cloud Document API.
n8n Configuration: Ensure the Feishu credential is set up in your n8n instance.

Troubleshooting

Missing or invalid credentials: If the Feishu credentials are not set up or are incorrect, the node will fail to authenticate.
Invalid 文档 ID: Providing a non-existent or inaccessible document ID will result in an error from the Feishu API.
Pagination issues: Not handling the 分页标记 (page_token) correctly may result in incomplete data retrieval.
Common error messages:
- "未实现方法: doc.doc:getAllBlocks": Indicates the requested resource/operation combination is not implemented in the node.
- API errors (e.g., permission denied, rate limits) will appear in the error field if "Continue On Fail" is enabled.

How to resolve:

Double-check credentials and permissions.
Verify the document ID and ensure the account has access.
Handle pagination tokens as described in the property meaning.