Environment Variables

List Environment Variables

Returns the organization's environment variables, sorted by key. Reference one from any string value in Configure Action's inputs using its reference token (e.g. {{env.api_base}}), on its own or mixed with literal text. The value is substituted for every row when the workflow runs.

Values are never returned by this API. Each entry carries the definition and value_count — how many scope points have a value — so you can tell a configured variable from an empty one. Values are set in the Floqer app.

Scopes. org — one value for the whole organization, usable anywhere. user — one value per member, resolved against the workflow's owner (not whoever triggers the run), usable anywhere. workflow — one value per workflow, so it resolves ONLY in workflows that have a value set for it.

Pass workflow_id to get the list usable in that workflow: workflow-scoped variables with no value there are omitted. Without it you get the org-wide inventory, which can include workflow-scoped variables that resolve nowhere you are currently building.

Environment variables cannot be used in conditions (run_if, or the Filter action's path_conditions) — they are substituted after conditions are evaluated. Configure Action returns a warning and skips the condition if you try.

Requires the workflows:read scope.

get/api/v1/environment-variables/

Request

  • Base URL
    http://localhost:3009
  • Auth
    HTTP bearer

Query parameters

workflow_idstring uuid

Restrict the list to variables usable in this workflow — drops workflow-scoped variables that have no value set for it. A sheet ID also works; it resolves to its parent workflow.

Response

Default Response

statusinteger required

Example response

{
  "data": [
    {
      "reference": "{{env.api_base}}"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.