Skip to main content
GET
Get Agent Transfer Variables
Read only Get agent transfer variables before configuring a Connect To Agent node in an IVR menu. The response reads the target’s latest published version so you can provide the fallback values required for publishing.

Before you begin

  • Publish the non-IVR target agent in the same workspace.
  • Get its ID from List Agents.

Get Agent Transfer Variables Request

Verify the result

A 200 response contains data.variables and data.defaults. Set a non-empty string fallback for every returned variable on the IVR node. Defaults include existing string values that can prefill those fields. This endpoint does not save those values.

Errors and recovery

401 means the API key is missing or invalid. Missing, deleted, unpublished, or out-of-workspace targets return empty variables and defaults. An empty response alone does not prove the target is usable; verify its published state. Reads are safe to retry.

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Agent ID from List Agents.

Example:

"agent_2g7Xy3tY53gRlp"

Response

Successful response.

success
boolean
required
error
boolean
required
statusCode
integer
required
message
string
required
data
object
required
timestamp
string<date-time>
required