variable

list variables

get/w/{workspace}/variables/list

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/w/{workspace}/variables/list
  • Auth: one of:
    • HTTP bearer
    • API key in cookie token

Path parameters

workspacestring required

Query parameters

path_startstring

filter variables by path prefix

pathstring

exact path match filter

descriptionstring

pattern match filter for description field (case-insensitive)

valuestring

pattern match filter for non-secret variable values (case-insensitive)

broad_filterstring

broad search across multiple fields (case-insensitive substring match)

pageinteger

which page to return (start at 1, default 1)

per_pageinteger

number of items to return for a given page (default 30, max 100)

labelstring

Filter by label

include_draft_onlyboolean

When true, append per-user draft variables whose path has no deployed variable. Synthesized rows carry draft_only: true so the home page can render a "Draft" badge.

Response

variable list

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

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.

Changes

No recorded changes to this operation across all 292 revisions of this API.