Retool API
Programmatically manage your organization using Retool's REST API.
| Retool API Availability | |||
|---|---|---|---|
| Cloud | Generally Available | ||
| Self-hosted Edge 3.33 or later | Generally Available | ||
| Self-hosted Stable 3.33 or later | Generally Available | ||
The Retool API enables you to perform actions across your organization or its spaces. You can perform RESTful requests to manage a wide range of objects, such as adding users or updating resource configurations.
Access scope
The Retool API is available on a Business or an Enterprise plan. Each plan tier provides increasing levels of API access.
The endpoints available depend on your organization's pricing plan. Available endpoint categories include:
| Feature | Business | Enterprise |
|---|---|---|
| User Invites | ✓ | ✓ |
| User Attributes | ✓ | ✓ |
| Custom Component Library | ✓ | ✓ |
| Source Control operations | ✓ | |
| Group User Invites | ✓ | |
| Workflow Run details | ✓ | |
| User Management, Groups, Folders, Spaces | ✓ | |
| App Themes, SSO Configuration, Permissions | ✓ | |
| Resources, Environments, Configuration Variables | ✓ | |
| Observability, Usage Analytics, Organization Settings | ✓ |
Organizations on an Enterprise plan should contact their account manager for full information about available endpoints.
Availability
The Retool API is available to both cloud- and self-hosted organizations on a Business or an Enterprise plan. The base URL for the API depends on which type of hosting applies to you.
All cloud-hosted organizations make use of the same base URL:
https://api.retool.com/api/v2/
Self-hosted organizations must use the deployment's URL when configuring the base URL:
https://retool.example.com/api/v2/
Versioning
While the Retool API is not explicitly versioned, Retool does make backwards-compatible changes to it over time, such as support for additional endpoints or parameters.
Cloud-hosted organizations always use the latest version of the Retool API. Self-hosted organizations use the version tied to their deployment's release version. To access any new endpoints or API changes, you must upgrade the self-hosted deployment.