Skip to main content

REST API

ToolJet can connect to any REST endpoint available.

Connection

To add a new REST API datasource, click the Datasource manager icon on the left-sidebar of the app builder and click on the Add datasource button, then select REST API from the modal that pops up. Click on the 'Save' button to save the datasource.

ToolJet - Datasource - REST API

ToolJet requires the following to connect to a REST API datasource.

  • URL of the REST endpoint

The following optional parameters are also supported:

TypeDescription
URL paramsAdditional query string parameters
headersAny headers the REST API source requires
bodyAny values or fields the REST API source requires
info

REST HTTP methods that are supported are GET, POST, PUT, PATCH & DELETE.

ToolJet - Datasource - REST API

Querying REST API

Click on + button of the query manager at the bottom panel of the editor and select the REST API endpoint added in the previous step as the datasource.

Click on the 'run' button to run the query.

note

NOTE: Query should be saved before running.

tip

Query results can be transformed using transformations. Read our transformations documentation to see how: link