Tulip icon

Tulip

Consume Tulip API

Overview

This node interacts with the Tulip API to list tables within a Tulip environment. It is useful for users who want to retrieve an overview of all tables available in their Tulip account, including optionally those that have been deleted. Typical use cases include synchronizing table metadata, auditing table presence, or integrating Tulip data structures into other workflows.

For example, a user might use this node to fetch all active tables to display them in a dashboard or to trigger further processing based on table contents.

Properties

Name Meaning
Include Deleted Tables Whether to include tables that have been deleted in the response. Options: true or false (default: false).

Output

The node outputs JSON data representing the list of tables retrieved from the Tulip API. Each item in the output typically contains metadata about a table such as its identifier, name, and status (active or deleted). The exact structure depends on the Tulip API response but generally includes:

  • Table ID
  • Table Name
  • Status (e.g., active or deleted)
  • Other relevant metadata fields provided by the API

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating with the Tulip API.
  • The node depends on the Tulip API being accessible and properly configured.
  • No additional external dependencies are indicated beyond the bundled code.

Troubleshooting

  • Common issues:
    • Authentication failures due to invalid or missing API credentials.
    • Network connectivity problems preventing access to the Tulip API.
    • Permission errors if the API key does not have rights to list tables.
  • Error messages:
    • Authentication errors usually indicate invalid credentials; verify and update the API key.
    • Timeout or network errors suggest checking internet connection or API endpoint availability.
    • API permission errors require ensuring the API key has sufficient privileges.

Links and References

Discussion