---
title: "list variables"
method: GET
path: "/w/{workspace}/variables/list"
tags: ["variable"]
---

# list variables

`GET /w/{workspace}/variables/list`

## Path parameters

- `workspace` string, required

## Query parameters

- `path_start` string
- `path` string
- `description` string
- `value` string
- `broad_filter` string
- `page` integer
- `per_page` integer
- `label` string
- `include_draft_only` boolean

## Response `200`

variable list

- ListableVariable[]
  - `workspace_id` string, required
  - `path` string, required
  - `value` string
  - `is_secret` boolean, required
  - `description` string
  - `account` integer
  - `is_oauth` boolean
  - `extra_perms` object, required
  - `is_expired` boolean
  - `refresh_error` string
  - `is_linked` boolean
  - `is_refreshed` boolean
  - `expires_at` string, date-time
  - `labels` string[]
  - `inherited_labels` string[] — Labels inherited from the parent folder, computed at read time. Read-only — edit them on the folder.
  - `ws_specific` boolean
  - `edited_at` string, date-time
  - `edited_by` string
  - `draft_only` boolean — True when this row is a per-user draft with no deployed variable at the same path. Frontend renders a "Draft" badge.
  - `is_draft` boolean — 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.

---

[API](https://skmtc.net/windmill/apis/windmill-api.md) · [All operations](https://skmtc.net/windmill/apis/windmill-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/windmill/windmill-api/versions/155a35b3caff/schema)