Overview

ToolJet API reference

Enable and authenticate#

Set the documented environment variables on the instance:

ENABLE_EXTERNAL_API=true
EXTERNAL_API_ACCESS_TOKEN=<access_token>

Send the token as a Basic authorization value:

curl -X GET 'https://your-tooljet-instance.com/api/ext/users' \
  -H 'Authorization: Basic <access_token>' \
  -H 'Content-Type: application/json'
GET/api/ext/users
Features

Retrieve all users.

Input0
Authorizationheaderrequired
Basic <access_token>Sent from your browser straight to the API — never to Docsbook, never stored.
Example input
curl 'https://your-tooljet-instance.com/api/ext/users' \
  -H 'Authorization: Basic <access_token>'
GET/api/ext/workspaces
Features

Retrieve all workspaces.

Input0
Authorizationheaderrequired
Basic <access_token>Sent from your browser straight to the API — never to Docsbook, never stored.
Example input
curl 'https://your-tooljet-instance.com/api/ext/workspaces' \
  -H 'Authorization: Basic <access_token>'
GET/api/ext/workspace/{workspace_id}/apps
Features

Retrieve application details for a workspace.

Input1
Authorizationheaderrequired
Basic <access_token>Sent from your browser straight to the API — never to Docsbook, never stored.
workspace_idstring · pathrequired
The workspace identifier
Example input
curl 'https://your-tooljet-instance.com/api/ext/workspace/{workspace_id}/apps' \
  -H 'Authorization: Basic <access_token>'

More endpoints#

The public ToolJet API page also documents user lookup, user creation and updates, role updates, workspace relation replacement, and application export. Use the upstream reference for the complete request and response schemas.

Next steps#

Review workspaces and permissions before granting tokens, then return to building apps.

Updated

Was this page helpful?