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 &.
Refer to the URL parameters guide for information on configuring custom parameters for use in apps.
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. Falls back to false if not set.
| Type | boolean |
| Mutability | Read-only |
_environment
The environment to load (e.g., staging). Falls back to production if not set.
| Type | string |
| Format | Plain Text |
| Mutability | Read-only |
_hideNav
Hides the Retool navigation bar. Falls back to false if not set.
| Type | boolean |
| Format | True/False |
| Mutability | Read-only |
Examples
true
_hideTimer
Hides the status bar which contains the query timer. Falls back to false if not set.
| Type | boolean |
| Format | True/False |
| Mutability | Read-only |
| Default | |
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 |
| Mutability | Read-only |
_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 |
| Mutability | Read-only |
| Default | |
Examples
"v1.0.0"
"latest"