AppFlowy icon

AppFlowy

Consume AppFlowy API

Actions6

Overview

This node interacts with the AppFlowy API to manage database rows within a specified workspace and database. Specifically, the "Get" operation for the "Database Row" resource retrieves a single database row by its ID. This is useful when you need to fetch detailed information about a specific record in an AppFlowy database.

Common scenarios include:

  • Retrieving a particular task or item from a project management database.
  • Fetching user data or configuration stored as a database row.
  • Accessing detailed content of a document or record for further processing or display.

Example: You have a database of customer orders in AppFlowy, and you want to retrieve the details of a specific order by its row ID to process it in your workflow.

Properties

Name Meaning
Workspace Name or ID The name or ID of the workspace containing the database. You can select from a list or specify dynamically using expressions.
Database Name or ID The name or ID of the database within the workspace. Options depend on the selected workspace.
Database Row ID The unique identifier of the database row to retrieve.
Include Document Data Whether to include the full document data (e.g., rich text or markdown content) associated with the row. Defaults to false.
Simplify Whether to return a simplified version of the response instead of the raw API data. Defaults to true. Simplified data is easier to work with in most workflows.

Output

The output is a JSON array where each element corresponds to a retrieved database row. For the "Get" operation, this will be a single object representing the requested row.

  • The json field contains the row's data, including its fields and optionally the document data if requested.
  • If "Simplify" is enabled, the data is transformed into a more straightforward structure, making it easier to access properties directly.
  • If "Include Document Data" is enabled, the output includes the full document content associated with the row.

No binary data is output by this operation.

Dependencies

  • Requires an active connection to the AppFlowy API via an API key credential configured in n8n.
  • The node depends on the AppFlowy API endpoints for workspaces, databases, and database rows.
  • Proper permissions are needed to access the specified workspace, database, and rows.

Troubleshooting

  • Missing or invalid IDs: Ensure that the workspace ID, database ID, and database row ID are correct and accessible. Using the provided dropdowns or valid expressions helps avoid errors.
  • API authentication errors: Verify that the API key credential is correctly set up and has sufficient permissions.
  • Row not found: If the specified row ID does not exist, the node may throw an error or return empty results.
  • Include Document Data issues: If enabled but the document data is missing or malformed, check that the row actually contains document content.
  • Simplify option: If disabled, the raw API response might be complex; enabling simplify usually resolves confusion over data structure.

If the node throws errors, enabling "Continue On Fail" can help isolate problematic items in batch operations.

Links and References

Discussion