Feishu Node icon

Feishu Node

Feishu Node

Actions106

Overview

This node integrates with the Feishu platform to query records from a multi-dimensional table (多维表格). It is designed to retrieve data entries based on specified filters and pagination parameters. This functionality is useful when you want to programmatically access structured data stored in Feishu's tables, such as fetching user information, project details, or any custom dataset maintained within Feishu.

Practical examples include:

  • Retrieving filtered records for reporting or analytics.
  • Paginating through large datasets to process or export data incrementally.
  • Automating workflows that depend on up-to-date table data from Feishu.

Properties

Name Meaning
多维表格 Token The unique identifier token of the Feishu App (多维表格 App) used to authenticate and specify which app's data to access.
多维表格 ID The unique identifier of the multi-dimensional table (数据表) within the Feishu App from which records will be queried.
用户 ID 类型 The type of user ID to use for identification. Options are: Open ID, Union ID, or User ID. This determines how users are referenced in queries or filters.
分页标记 Pagination token used to fetch subsequent pages of results. Leave empty on the first request to start from the beginning. When more results exist, the response includes a new page token to continue fetching.
分页大小 Number of records to return per page. Defaults to 20. Controls the size of each batch of query results.
请求体JSON JSON object representing the request body, including filter criteria and other search parameters. Users should refer to the official Feishu API documentation for the exact structure and options available here.

Output

The node outputs an array of JSON objects representing the queried records from the multi-dimensional table. Each item corresponds to a record matching the filter criteria specified in the request body.

If the query result includes binary data fields, those would be included accordingly, but this node primarily deals with JSON data representing table records.

Dependencies

  • Requires a valid Feishu App token and credentials configured in n8n to authenticate API requests.
  • Depends on Feishu's multi-dimensional table API endpoint for querying records.
  • The node expects the user to provide correct identifiers for the app and table, as well as properly formatted JSON for filtering.

Troubleshooting

  • Invalid or missing tokens: Ensure the "多维表格 Token" and "多维表格 ID" are correctly set and correspond to existing resources in Feishu.
  • Malformed JSON in 请求体JSON: The request body must be valid JSON following Feishu's API schema. Invalid JSON will cause errors.
  • Pagination issues: If using the pagination token incorrectly (e.g., stale or wrong token), the query may fail or return unexpected results.
  • API rate limits or permission errors: Make sure the API credentials have sufficient permissions and that usage stays within Feishu's rate limits.
  • Error messages: The node throws errors if the operation is not implemented or if the API call fails. Check error messages for hints about invalid parameters or connectivity issues.

Links and References

Discussion