Skip to main content

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.

Type boolean
Format True/False
Configurability Read-only
Defaultfalse
Examples
falsetrue

_environment​

The environment to load (e.g., staging).

Type string
Format Plain Text
Configurability Read-only
Defaultproduction
Examples
false"staging"

_hideNav​

Hides the Retool navigation bar.

Type boolean
Format True/False
Configurability Read-only
Defaultfalse
Examples
falsetrue

_hideTimer​

Hides the status bar which contains the query timer.

Type boolean
Format True/False
Configurability Read-only
Defaultfalse
Examples
falsetrue

_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
Formatinteger
Configurability Read-only
Defaultnull
Examples
false1

_releaseVersion​

The app version to load. By default (when this parameter is not set), Retool loads the most recent live (published) version of the app. If no live version exists, Retool falls back to the latest saved edit. Use _releaseVersion=latest to explicitly load the latest saved edit, including unpublished changes.

Type string
Format Plain Text
Configurability Read-only
Defaultmost recent live (published) version
Examples
false"v1.0.0"
false"latest"