Skip to main content
GET
Get state

Authorizations

Authorization
string
header
required

Voiceflow bearer token

Path Parameters

userID
string
required

The ID identifying this conversation. Any stable string you choose; the same value addresses the same conversation on every call.

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).

version
enum<string>
required

Which version of the environment to read: the editable draft or the published one.

Available options:
draft,
published

Response

200 - application/json

Returns the user's session state for the requested version of the environment: every variable and its current value, the runtime storage carried between turns, and the execution stack showing which diagram and node the conversation is sitting on.

state
object
required