Retool API
Programmatically manage your organization using Retool's REST API.
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.
API reference
Retool Docs also hosts the Retool API reference for cloud-hosted organizations.
Each Retool organization can access the Retool API reference at:
https://example.retool.com/reference
This API reference is locally available for self-hosted organizations and contains version-specific documentation for the installed release.
Availability
The Retool API is available to both cloud- and self-hosted organizations on a Business or an Enterprise plan. The endpoints available depend on your organization's pricing plan.
Base URL
All endpoints are relative to your Retool instance URL:
https://example.retool.com/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 currently in use. Cloud-hosted instances always use the latest version of Retool.
For hosted instances, such as self-hosted deployments, the API version reflects the features and endpoints available in the release currently deployed. When you upgrade your Retool instance, the API version updates alongside it and any new endpoints or capabilities introduced in that release become available.