Skip to content
Nappai Documentation

List Database Properties

⚠️ DEPRECATION WARNING

This component is deprecated and will be removed in a future version of Nappai. Please migrate to the recommended alternative components.

The List Database Properties component lets you pull the structure of a Notion database—its columns, types, and settings—directly into your Nappai workflow. It’s useful when you need to understand or manipulate the layout of a database before working with its data.

How it Works

When you run the component, it sends a request to the Notion API using the database ID you provide. The API returns a JSON object that includes a properties field. The component extracts this field and returns it as a simple dictionary. If the request fails, the component returns a clear error message instead of crashing.

Inputs

Before you can use the component, you must set up a Notion API credential in Nappai’s credential manager.

  1. Go to Credentials → Add Credential → choose Notion API.
  2. Enter your Notion Integration Token (found in the Notion integration settings).
  3. In the component, select this credential in the Credential field.

The component itself only needs one input:

  • Database ID: The unique identifier of the Notion database you want to inspect.
    • Visible in: All uses of the component.

Outputs

  • Data: A Data object containing the database properties as a dictionary.
  • Tool: A Tool object that can be used by agents to retrieve the same information on demand.

Usage Example

  1. Add the component to your workflow.
  2. Configure the credential as described above.
  3. Enter the Database ID (you can copy it from the Notion URL).
  4. Run the workflow.
  5. The Data output will show a list of properties like Name, Created Time, Tags, etc., which you can then feed into other components or display in a dashboard.
  • NotionDatabaseLoader – Loads all rows from a Notion database.
  • NotionPageUpdater – Updates fields in a Notion page.
  • NotionDatabaseCreator – Creates a new Notion database.

Tips and Best Practices

  • Double‑check the Database ID; a typo will return an error.
  • Keep your Notion Integration Token secret—do not share it in public workflows.
  • Use the Data output to feed into a table component for visual inspection.
  • If you need to work with many databases, consider creating a small lookup table of IDs and names.

Security Considerations

  • The Notion Integration Token is stored securely in Nappai’s credential store.
  • The component never logs the token or any sensitive data.
  • Ensure that only trusted users have access to the credential and the component in shared workspaces.