Skip to main content

GetSurveyForExecution fetches a published version's questions for delivery.

GET 
/api/v1/surveys/execution/:surveyVersionId

Called by execution engines (IVR handlers, chat bots, webchat widgets) at runtime to render the survey to participants. Returns only the data required for presentation: ordered questions, their options, validation rules, and runtime settings.

Parameters​

  • survey_version_id: Required, version to execute (> 0).

Response​

  • survey_version_id: Echoed back for client correlation.
  • settings: Runtime hints from the survey (intro message, timeout, etc.).
  • mandatory: Whether completion is required (from the assignment).
  • questions: Ordered question list with options and validation rules.

Request​

Responses​

A successful response.