REST API

ToolJet API Reference

Manage users, workspaces, applications, and more — all programmatically. Integrate ToolJet into your CI/CD pipelines, identity providers, and internal tooling without ever touching the UI.

Enabling ToolJet API

Before making API calls, you need to enable the external API and set an access token on your ToolJet instance. Add these two variables to your .env file and restart the server:

Variable	Description
ENABLE_EXTERNAL_API	Set to true to enable the external API
EXTERNAL_API_ACCESS_TOKEN	A secure random string used as the API access token

Generating an Access Token

You can generate a secure access token using openssl. The following command produces a cryptographically random 64-character base64 string:

openssl rand -base64 48

Copy the output and use it as the value for EXTERNAL_API_ACCESS_TOKEN in your .env file.

warning

Keep this token secret — it grants full API access to your ToolJet instance. Rotate it if it is ever exposed.

Authentication

All API requests require a Basic access token in the Authorization header. Use the token you configured in EXTERNAL_API_ACCESS_TOKEN:

Authorization: Basic <access_token>

note

SCIM endpoints use a separate token. See the SCIM setup guide for configuration.

Explore the APIs

ToolJet API

Manage users, workspaces, apps, modules, and groups programmatically.

20 endpoints→

GitSync API

Automate git sync operations and CI/CD pipelines for ToolJet applications.

5 endpoints→

SCIM

Provision and manage users and groups via the SCIM 2.0 standard.

12 endpoints→