Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Retool Users API

Create, read, update, and delete users within a Retool organization. Manage user roles (admin, standard, end-user) and activation status.

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

Tagged areas include Users. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 5 operations across 2 paths, and defines 6 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://api.retool.com/v1.

5 operations 2 paths 6 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Server
https://api.retool.com/v1
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

Retool Users API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Bearer token generated in Retool workspace settings under API Access Tokens. Format: Authorization: Bearer

Paths & Operations 5

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

Users 5

Create, read, update, and delete users within a Retool organization. Manage user roles (admin, standard, end-user) and activation status.

GET
/users
List Users
listUsers 2 params → 200401403500
POST
/users
Create User
createUser body → 201400401403409500
GET
/users/{userId}
Get User
getUser 1 param → 200401403404500
PUT
/users/{userId}
Update User
updateUser 1 param body → 200400401403404500
DELETE
/users/{userId}
Delete User
deleteUser 1 param → 204401403404500

Schemas 6

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

UserListResponse
object
Paginated list of users.
4 properties
Error
object
An error response.
2 properties
UpdateUserRequest
object
Request body for updating an existing user.
4 properties
GroupRef
object
A reference to a group.
2 properties
User
object
A Retool user account.
10 properties
CreateUserRequest
object
Request body for creating a new user.
5 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

retool-users-api-openapi.yml Raw ↑

Other APIs Retool publishes across the network.

Retool SCIM 2.0 API
Retool Platform
Retool Apps API
Retool Folders API
Retool Groups API
Retool Resources API