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 Groups API

Manage groups and group membership. Groups control access to apps, resources, and workflows within the organization.

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

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

This API exposes 4 operations across 3 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.

4 operations 3 paths 6 schemas 1 DELETE1 GET2 POST

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 Groups 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 4

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

Groups 4

Manage groups and group membership. Groups control access to apps, resources, and workflows within the organization.

GET
/groups
List Groups
listGroups → 200401403500
POST
/groups
Create Group
createGroup body → 201400401403500
POST
/groups/{groupId}/members
Add Member to Group
addGroupMember 1 param body → 200400401403404500
DELETE
/groups/{groupId}/members/{userId}
Remove Member from Group
removeGroupMember 2 params → 204401403404500

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are Group (5 properties), UserRef (2 properties), Error (2 properties), GroupListResponse (1 property). Each schema is shown below with its type and property counts.

AddGroupMemberRequest
object
Request body for adding a user to a group.
1 property 1 required
Error
object
An error response.
2 properties
CreateGroupRequest
object
Request body for creating a new group.
1 property 1 required
GroupListResponse
object
List of groups.
1 property
UserRef
object
A reference to a user.
2 properties
Group
object
A Retool group for managing permissions.
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

retool-groups-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 Resources API
Retool Users API