Get Variable By ID

Gets a variable, this route must use the new V3 endpoints.

GET /variables/{variableId}

Get a variable by id

cURL

curl --request GET \
  --url https://eu-gcp-api.vg-stuff.com/v3/variables/{variableId} \
  --header 'Authorization: Bearer <token>'

200

{
  "success": true,
  "message": "<string>",
  "data": {
    "id": "<string>",
    "in": "<string>",
    "value": "<unknown>",
    "defaultValue": "<unknown>",
    "key": "<string>",
    "description": "<string>",
    "required": true,
    "reusable": true,
    "isEnv": true,
    "isSystem": true,
    "isGlobal": true,
    "agentId": "<string>",
    "userId": "<string>"
  }
}

Returns full variable configuration including its current value and default value.

System variables (type: "system") provide built-in values like conversation ID or user info.

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

variableId · string · required

Response

200

application/json

Successful response

success · boolean · required

message · string · required

data · object · required

Show child attributes