Get Variable Value

Evaluates a single variable by its unique name and returns both its raw and formatted values.

Remarks:

  • The variable must be in promoted status before it can be evaluated; unpromoted variables will fail evaluation. "Promoted" means a version of the variable has been explicitly marked as the active, published version via Update Variable — draft versions are not evaluable.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length ≥ 1

The unique, human-readable name of the variable to evaluate.

Query Params
boolean
Defaults to false

When false (default), evaluates the latest promoted version of the variable. When true, evaluates the absolute latest version regardless of promotion status. Note: this parameter's name intentionally preserves a long-standing spelling ("useLastest", not "useLatest") to match the actual query parameter this endpoint reads.

Body Params

Optional evaluation context, required only for variables whose valueDefinition is CRMVariableValueDefinition.

context
object

Identifies which connected CRM record to evaluate a CRM-sourced variable against. Required when evaluating any variable whose valueDefinition is CRMVariableValueDefinition.

parameters
object

Named evaluation parameters, keyed by parameter name, passed through to the variable's value source at evaluation time.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json