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/usersFeatures
Retrieve all users.
Input0
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>'Example output
GET
/api/ext/workspacesFeatures
Retrieve all workspaces.
Input0
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>'Example output
GET
/api/ext/workspace/{workspace_id}/appsFeatures
Retrieve application details for a workspace.
Input1
Basic <access_token>Sent from your browser straight to the API — never to Docsbook, never stored.The workspace identifier
Example input
curl 'https://your-tooljet-instance.com/api/ext/workspace/{workspace_id}/apps' \
-H 'Authorization: Basic <access_token>'Example output
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.