How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

ToolJet Users API

User management endpoints

ToolJet Users API is one of 4 APIs that ToolJet publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 2 JSON Schema definitions.

Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 2 JSON Schemas.

This API exposes 8 operations across 5 paths, and defines 10 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://{instance}/api/ext.

8 operations 5 paths 10 schemas 3 GET2 PATCH1 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://your-tooljet-instance.com/api/ext
Authentication
HTTP Basic
Contact
License
Resource Areas
1

Authentication & Security 1

ToolJet Users API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (BasicAuth). By default, every request must be authenticated.

  • BasicAuth — Static access token configured via the TOOLJETSERVICETOKEN environment variable. Pass the token as the username with an empty password, encoded as Base64 in th…

Paths & Operations 8

Across 5 paths, the API surfaces 8 operations — 3 GET, 2 PATCH, 1 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Users 8

User management endpoints

GET
/users
List all users
getAllUsers → 200401
POST
/users
Create a user
createUser body → 201400401
GET
/user/{id}
Get a user by ID
getUser 1 param → 200401404
PATCH
/user/{id}
Update a user
updateUser 1 param body → 200400401404
PUT
/user/{id}/workspaces
Replace user workspaces
replaceUserWorkspaces 1 param body → 200401404
PATCH
/user/{id}/workspace/{workspaceId}
Update user workspace membership
updateUserWorkspace 2 params body → 200401404
GET
/workspace/{workspaceId}/user/{userId}
Get user metadata in workspace
getUserMetadata 2 params → 200401404
PUT
/workspace/{workspaceId}/user/{userId}
Update user metadata in workspace
updateUserMetadata 2 params body → 200401404

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are User (6 properties), CreateUserDto (6 properties), WorkspaceDto (5 properties), UpdateUserDto (5 properties). Each schema is shown below with its type and property counts.

UpdateUserMetadataDto
object
1 property 1 required
User
object
6 properties
ErrorResponse
object
3 properties
UpdateGivenWorkspaceDto
object
4 properties
UserRole
string
CreateUserDto
object
6 properties 3 required
GroupDto
object
2 properties
WorkspaceDto
object
5 properties
Status
string
UpdateUserDto
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tooljet-users-api-openapi.yml Raw ↑

Other APIs ToolJet publishes across the network.

ToolJet Applications API
ToolJet Groups API
ToolJet Workspaces API
Where this information came from

This is an independent, third-party profile of ToolJet Users API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.