Retool

The Retool API enables you to programmatically perform actions across your organization and its spaces. You can perform RESTful requests to manage a wide range of objects, such as adding users or updating resource configurations.

Base URL

All endpoints are relative to your Retool instance URL:

https://{your-retool-instance}/api/v2

Authentication

The Retool API uses HTTP Bearer authentication scheme with API tokens to authenticate requests. Users with sufficient permissions can create API tokens in the organization's Retool API settings. Each token can be scoped to specific permissions—only grant the scopes needed for your use case.

Authorization: Bearer YOUR_API_TOKEN

Versioning

The API version corresponds to the Retool release version in which it was shipped. This means the API version reflects the features and endpoints available in that release. When you upgrade your Retool instance, the API version updates alongside it and any new endpoints or capabilities introduced in that release become available.

Operations

Get an access request

Approve or deny an access request

List access requests

Get an access token

List access tokens

Create an access token

List app themes

Delete an app theme

Get an app theme

Create an app theme

Update an app theme

Delete an app

Get an app

Clone an app

List apps

List configuration variables and their values

Delete a configuration variable

Get a configuration variable

Update a configuration variable

Create a configuration variable

List custom component libraries

Get a custom component library

List revisions of a custom component library

Create a custom component library revision

List files for a custom component library revision

Create a custom component library

Delete an environment

Get an environment

Update an environment

List environments

Create an environment

Delete a folder

Get a folder

Update a folder

List folders

Create a folder

List groups

Delete a group

Get a group

Add users to a group

Remove a user from a group

Update a group

Replace a group

Add user invites to a group

Remove a user invite from a group

Create a group

Get IP allowlist by region

Delete an observability configuration

Update an observability configuration

List observability configurations

Create an observability configuration

Send a test error event

Get organization AI settings

Update organization AI settings

Get organization analytics integrations

Get organization settings

Invalidate all sessions

Update organization settings

Get an access list

Grant permissions

List objects a group can access

Revoke permissions

Delete a resource configuration

Get a resource configuration

Update a resource configuration

List resource configurations

Create a resource configuration

List resources

Create a resource

Delete a resource

Get a resource

Update a resource

Delete a role grant for a subject

List role grants

Create a role grant

Delete a role grant

Get role grants for a subject

List roles

Create a role

Delete a role

Update a role

Delete source control configuration

Get source control configuration

Create source control configuration

Set source control configuration

Deploy latest changes

Get a deployment

List source control deployments

List release manifests

Delete a release manifest

Delete element from release manifest

Set release version for element in manifest

Get a release manifest

Set release manifest

List all available releases for the given element

Create a release artifact

Get source control settings

Set source control settings

Test source control connection

Test source control changes

Copy elements to another space

List spaces

Create a space

Delete a space

Get a space

Update a space

Remove SSO configuration

Get SSO configuration

Set SSO configuration

Get app usage details

Get app usage summaries

Get usage summary

List organizations

Get user usage details

Get user usage summaries

List organization user attributes

Delete an organization user attribute

Update an organization user attribute

Create an organization user attribute

List user invites

Create a user invite

Delete a user invite

Get a user invite

Delete a user attribute on a user invite

Add or update user attributes on a user invite

List user tasks

Cancel a user task

Reassign a user task

Submit a user task

List users

Create a user

Reset a user's two-factor authentication

Delete a user

Get a user

Log out a user

Update a user

Delete a user attribute

Create or update a user attribute

Get a workflow run

List workflows

Delete a workflow

Get a workflow