Get variable

curl --request GET \
  --url https://realtime-api.voiceflow.com/v1/stable/variable/<variableID> \
  --header 'Authorization: Bearer <token>'

const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/variable/<variableID>?projectID=<projectID>&environmentAlias=<environmentAlias>', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer <token>',
  },
});
const data = await response.json();

import requests

response = requests.get(
    'https://realtime-api.voiceflow.com/v1/stable/variable/<variableID>?projectID=<projectID>&environmentAlias=<environmentAlias>',
    headers={'Authorization': 'Bearer <token>'},
)
data = response.json()

{
  "variable": {
    "id": "<string>",
    "name": "<string>",
    "color": "<string>",
    "isSystem": true,
    "createdAt": "2026-09-10T00:00:00.000Z",
    "updatedAt": "2026-09-10T00:00:00.000Z",
    "description": "<string>",
    "defaultValue": "<string>"
  }
}

Get variable

Returns a single variable by ID, with the fields that define it. A variable is a named slot of project state an agent can read and write.

GET

/v1/stable/variable/{variableID}

Get variable

curl --request GET \
  --url https://realtime-api.voiceflow.com/v1/stable/variable/<variableID> \
  --header 'Authorization: Bearer <token>'

const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/variable/<variableID>?projectID=<projectID>&environmentAlias=<environmentAlias>', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer <token>',
  },
});
const data = await response.json();

import requests

response = requests.get(
    'https://realtime-api.voiceflow.com/v1/stable/variable/<variableID>?projectID=<projectID>&environmentAlias=<environmentAlias>',
    headers={'Authorization': 'Bearer <token>'},
)
data = response.json()

{
  "variable": {
    "id": "<string>",
    "name": "<string>",
    "color": "<string>",
    "isSystem": true,
    "createdAt": "2026-09-10T00:00:00.000Z",
    "updatedAt": "2026-09-10T00:00:00.000Z",
    "description": "<string>",
    "defaultValue": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Voiceflow bearer token

Path Parameters

variableID

string

required

Query Parameters

projectID

string

required

The ID of the project to operate on.

environmentAlias

string

required

The alias of the environment to operate on (e.g. main).

Response

200 - application/json

Returns a single variable by ID, carrying its current description, default value, colour, and timestamps.

variable

object

required

Show child attributes

string

required

name

string

required

color

string

required

The display color of the variable in the Voiceflow editor.

isSystem

boolean

required

Whether this is a built-in system variable, which cannot be updated or deleted.

createdAt

string

required

updatedAt

string

required

description

string

required

A short description of what the variable stores.

defaultValue

string

required

The initial value of the variable at the start of a conversation.

Getting started

Running agents

Build

Manage

Publishing

Observe

Insights

QA

Analytics

Webhooks

Get variable

Authorizations

Path Parameters

Query Parameters

Response

Getting started

Running agents

Build

Manage

Publishing

Observe

Insights

QA

Analytics

Webhooks