Skip to content
Nappai Documentation

List Users

⚠️ DEPRECATION WARNING

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

This component lets you pull a list of all users from your Notion workspace. It connects to Notion’s API and returns each user’s ID, type, name, and avatar URL. The data can then be used in other parts of your workflow, such as displaying in a table or feeding into a decision logic.

How it Works

When you add the component to your dashboard, it first asks you to select a Notion API credential that you have previously set up in Nappai’s credentials section. Once the credential is chosen, the component sends a request to the Notion API endpoint https://api.notion.com/v1/users. The API responds with a list of users, and the component formats each user’s information into a readable text block and a structured data record. Two outputs are produced:

  • Data – a list of Data objects that contain the formatted text and the raw user data.
  • Tool – a reusable tool that can be called by other components or agents to retrieve the same list of users on demand.

Inputs

Input Fields

The following field is available to configure this component. Each field may be visible in different operations:

  • Credential: Select the Notion API credential that contains your integration token.
    • Visible in: All

How to set up the credential

  1. Go to the Credentials section of Nappai and create a new Notion API credential.
  2. Provide the Notion Integration Token (you can find the token here).
  3. Save the credential and then select it in the Credential field of this component.

Outputs

  • Data (method: run_model) – A list of Data objects, each containing a formatted text block and the raw user data.
  • Tool (method: build_tool) – A structured tool that can be invoked by other components or agents to retrieve the same list of users.

Usage Example

  1. Add the component to your workflow.
  2. Select the Notion API credential you created earlier.
  3. Run the workflow.
  4. The Data output will contain a readable list of users that you can feed into a table component, a notification, or any other downstream component.
  • NotionDatabaseLoader – Load data from a specific Notion database.
  • NotionPageLoader – Retrieve the content of a single Notion page.

Tips and Best Practices

  • Make sure your Notion integration has read permissions for the users you want to list.
  • Use the Data output to populate a table or a dropdown for user selection in subsequent steps.
  • If you only need the user IDs, you can filter the Data output in a later component.

Security Considerations

  • Keep your Notion Integration Token confidential; it grants access to all users in your workspace.
  • Store the token in Nappai’s secure credential store and never expose it in logs or UI.