List Conversation Variables

curl --request GET \
  --url https://{deployed_api_base_url}/v2/conversations/{conversation_id}/variables \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{deployed_api_base_url}/v2/conversations/{conversation_id}/variables"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{deployed_api_base_url}/v2/conversations/{conversation_id}/variables', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{deployed_api_base_url}/v2/conversations/{conversation_id}/variables",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{deployed_api_base_url}/v2/conversations/{conversation_id}/variables"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{deployed_api_base_url}/v2/conversations/{conversation_id}/variables")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "limit": 20,
  "has_more": false,
  "data": [
    {
      "id": "6fa459ea-ee8a-3ca4-894e-db77e160355e",
      "name": "order_context",
      "value_type": "object",
      "value": "{\"order_id\":\"ORDER-1001\",\"priority\":true}",
      "description": "Current order context",
      "created_at": 1787788800,
      "updated_at": 1787788860
    }
  ]
}

GET

conversations

{conversation_id}

variables

List Conversation Variables

curl --request GET \
  --url https://{deployed_api_base_url}/v2/conversations/{conversation_id}/variables \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{deployed_api_base_url}/v2/conversations/{conversation_id}/variables"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{deployed_api_base_url}/v2/conversations/{conversation_id}/variables', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{deployed_api_base_url}/v2/conversations/{conversation_id}/variables",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{deployed_api_base_url}/v2/conversations/{conversation_id}/variables"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{deployed_api_base_url}/v2/conversations/{conversation_id}/variables")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "limit": 20,
  "has_more": false,
  "data": [
    {
      "id": "6fa459ea-ee8a-3ca4-894e-db77e160355e",
      "name": "order_context",
      "value_type": "object",
      "value": "{\"order_id\":\"ORDER-1001\",\"priority\":true}",
      "description": "Current order context",
      "created_at": 1787788800,
      "updated_at": 1787788860
    }
  ]
}

Authorizations

Authorization

string

header

required

Every request authenticates with an API key: Authorization: Bearer {API_KEY}. App endpoints take an app API key; knowledge endpoints take a knowledge base API key (Get Started).

Keep keys server-side; never embed them in client code. Requests with a missing or invalid key fail with HTTP 401 (unauthorized).

Path Parameters

conversation_id

string<uuid>

required

ID of the conversation whose variables to list. Get conversation IDs from List Conversations.

Query Parameters

user

string

required

End-user identifier, defined by your app and unique within it. Conversations belong to the app, the environment, and this user together; later reads and changes must send the same value. See End User Identity.

Required string length: 1 - 255

last_id

string<uuid>

Pagination cursor: the id of the last variable on the current page. Omit to fetch the first page.

limit

integer

default:20

Number of records to return.

Required range: 1 <= x <= 100

variable_name

string

Matches variables whose name contains this text, ignoring case.

Required string length: 1 - 255

Response

One page of the conversation's variables, oldest first.

limit

integer

Page size applied to this page.

has_more

boolean

Whether another page exists.

data

object[]

Conversation variables, oldest first.

Show child attributes

Guides

App APIs

Knowledge APIs

List Conversation Variables

Authorizations

Path Parameters

Query Parameters

Response