Retool API
Programmatically manage your organization using Retool's REST API.
| Retool API Availability | |||
|---|---|---|---|
| Cloud-hosted | Generally Available | ||
| Self-hosted (3.259 Edge) | Generally Available | ||
| Self-hosted (3.148 Stable and later) | |||
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 endpoints available depend on the pricing plan to which your organization subscribes. Customers on the Business plan have a limited access scope whereas customers on the Enterprise plan have full access scope.
Business customers can access API endpoints for the following groups:
- User Invites
- User Attributes
- Custom Component Library
Availability
The Retool API is available to both cloud- and self-hosted organizations. 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 organizatons 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 organizatons 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.