APIs

OpenAPI
integration

Use an OpenAPI specification to connect API operations to ToolJet apps.

Start building Read the setup guide

Configure your connection, create queries, and build the interface your team needs. Try a sample prompt

Connector capabilities

What can ToolJet do with OpenAPI?

Create queries for the operations your app needs, then connect their inputs and results to the interface.

Load an OpenAPI specification
Configure operation parameters
Run API operations

Operations and configuration can vary by connector version. Check the full OpenAPI guide.

An app you could build

Internal service console

Select an operation from your API specification, supply its parameters through a form, and present the response in a table or detail view.

Try this prompt

I have an OpenAPI specification for an internal service with an order lookup operation. Build a service console with a form for the operation's required parameters. Run the request on button click and show the response or a useful error message.

Start with this prompt in ToolJet. Sign in or create an account, then connect your data source and replace the example names and fields with yours.

Review the generated app, configure permissions, and test its queries before sharing it with your team.

Explore app templates

Connect OpenAPI

Start with the connection.

Before you begin

Access to the OpenAPI account or endpoint you intend to connect, with the credentials and permissions specified in its setup guide.

Add the data source
Open Data Sources in your ToolJet workspace. Select OpenAPI and enter the required connection details.
Configure and test a query
Choose an operation and supply its inputs. Start with a read operation where available; test writes with non-production data.
Build the interface
Bind query results to components and connect actions to app events. Verify permissions and error handling before rollout.

OpenAPI setup guide

Before production

Authentication, available operations, and request limits are controlled by the upstream service. Validate inputs and show actionable errors when requests fail.

Review plans and deployment options

Frequently asked questions

What can I do with the OpenAPI integration?

Use an OpenAPI specification to connect API operations to ToolJet apps. Supported capabilities: Load an OpenAPI specification; Configure operation parameters; Run API operations.

What do I need to connect OpenAPI to ToolJet?

Access to the OpenAPI account or endpoint you intend to connect, with the credentials and permissions specified in its setup guide.

What should I check before using OpenAPI in production?

Authentication, available operations, and request limits are controlled by the upstream service. Validate inputs and show actionable errors when requests fail.

Can I automate tasks with OpenAPI?

Connect OpenAPI queries to app events such as button clicks and form submissions. ToolJet Workflows and Agent Builder can orchestrate supported connectors on Self-hosted deployments; those products are not available on ToolJet Cloud. Check the connector and deployment requirements for your use case.

Keep exploring