Built-in URL parameters
Learn about built-in URL parameters to control app behavior.
Public apps do not support built-in URL parameters.
Use built-in URL search parameters to control certain app characteristics when launched, such as loading a specific release or environment. Append ? to the app's URL and include the parameters as key=value pairs. Separate multiple parameters with &.
All properties for this object with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read property values.
_embed
Hides all non-app UI elements, such as the Retool header.
| Type | boolean |
| Format | True/False |
| Configurability | Read-only |
| Default | false |
Examples
true
_environment
The environment to load (e.g., staging).
| Type | string |
| Format | Plain Text |
| Configurability | Read-only |
| Default | production |
Examples
"staging"
_hideNav
Hides the Retool navigation bar.
| Type | boolean |
| Format | True/False |
| Configurability | Read-only |
| Default | false |
Examples
true
_hideTimer
Hides the status bar which contains the query timer.
| Type | boolean |
| Format | True/False |
| Configurability | Read-only |
| Default | false |
Examples
true
_historyOffset
Opens the Retool app to a previous point in its save history state. Only applies when launching an app with the latest release version.
| Type | number |
| Format | integer |
| Configurability | Read-only |
| Default | null |
Examples
1
_releaseVersion
The release version of the app to load. Falls back to the most recent live version or latest if not set
| Type | string |
| Format | Plain Text |
| Configurability | Read-only |
| Default | latest |
Examples
"v1.0.0"
"latest"