APIs

REST API
integration

Connect REST and SOAP API endpoints to ToolJet tables, forms, and action buttons.

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 REST API?

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

Configure HTTP requests
Send headers and parameters
Submit request bodies
Call SOAP APIs with XML request bodies

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

An app you could build

Support operations workspace

Read a record from an API, show it alongside a form, and send an explicit update request when an authorized operator confirms the change.

Try this prompt

I have a REST API with endpoints to look up orders and update their status. Build a support app with an order search and a detail panel. Add a status form that sends an update only after confirmation and shows the API result.

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 REST API

Start with the connection.

Before you begin

The API base URL, required authentication, and any headers or default parameters expected by the service.

Add the data source
Open Data Sources in your ToolJet workspace. Select REST API 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.

REST API setup guide

Before production

The upstream API controls permissions, pagination, rate limits, and available operations. Handle errors and validate write requests before sending them. SOAP services use this REST API connector with a POST request, an XML body, and the Content-Type and SOAPAction headers required by the service.

Review plans and deployment options

Questions, answered

REST API and ToolJet FAQ

What can I do with the REST API integration?

Connect REST and SOAP API endpoints to ToolJet tables, forms, and action buttons. Supported capabilities: Configure HTTP requests; Send headers and parameters; Submit request bodies; Call SOAP APIs with XML request bodies.

What do I need to connect REST API to ToolJet?

The API base URL, required authentication, and any headers or default parameters expected by the service.

What should I check before using REST API in production?

Can I automate tasks with REST API?

Connect REST API 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