Sign in

v106

latestOpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-08-03812347972.4 KB
variable

get variable

get/w/{workspace}/variables/get/{path}

Path parameters

workspacestring required
pathstring required

Query parameters

decrypt_secretboolean

ask to decrypt secret if this variable is secret (if not secret no effect, default: true)

include_encryptedboolean

ask to include the encrypted value if secret and decrypt secret is not true (default: false)

get_draftboolean

When true, overlay the authed user's draft (if any) onto the deployed payload.

Response

variable

workspace_idstring required
pathstring required
valuestring
is_secretboolean required
descriptionstring
accountinteger
is_oauthboolean
extra_permsobject required
is_expiredboolean
refresh_errorstring
is_linkedboolean
is_refreshedboolean
expires_atstring date-time
labelsstring[]
inherited_labelsstring[]

Labels inherited from the parent folder, computed at read time. Read-only — edit them on the folder.

ws_specificboolean
edited_atstring date-time
edited_bystring
draft_onlyboolean

True when this row is a per-user draft with no deployed variable at the same path. Frontend renders a "Draft" badge.

is_draftboolean required

True when the authed user has a per-user draft at this path (over a deployed row or a synthesized draft-only row). Frontend appends a * to the displayed name.

draft_saved_atstring date-time
no_deployedboolean
draftobject