URL query parameters

Retool has built-in URL query parameters that allow you to control some of the app's state when launched. You can include query parameters using the following URL format:

https://[organization].retool.com/apps/[app]?[parameter]=[value]

Parameter

Value

Description

_historyOffset

Any integer (1, 2, 3, etc.)

Opens the Retool app to a previous point in its save history, counting back from the latest state. This is useful if you need to roll back changes because an app is not in a functional state (e.g., an infinite loop).

If you edit an app while in an offset version, those changes are saved at the "newest" position in the app history. We recommend using releases as you make changes to apps.

_embed

true or false.

Hides all non-app UI. Useful for embedding Retool into other applications.

_releaseVersion

Any valid release number (e.g, 2.1.1) or latest.

Opens the Retool app to a specific release version. Helpful for testing or sharing new changes with teammates.

_environment

Any valid environment name (e.g., production or staging).

Opens the Retool app with the corresponding environment credentials. This is the same as clicking the environments dropdown via the UI.

📘

You can also define custom query parameters that can be used in queries and link directly to records.


Did this page help you?