SurveyWorkflow::Run

Fetch Full Survey Response

Changed on

Fetch one survey run with every saved answer. The survey_workflow_run.completed webhook sends the same run object. See the Forms and surveys guide.

get/survey_workflows/runs/{id}

Request

Path parameters

idstring required

Numeric ID or public_id.

Response

OK

idinteger

Survey response ID

public_idstring nullable

Public ID

survey_workflow_idinteger

Survey ID

contact_idinteger nullable

Respondent contact ID; null when the respondent is not identified

status'active' | 'paused' | 'completed' | 'canceled'

Response status; completed once the respondent finishes

previewboolean

True for a run from the survey builder's preview. Preview runs send no webhook.

completed_atstring date-time nullable

When the respondent finished; null until completed

canceled_atstring date-time nullable

When the response was canceled; null unless canceled

created_atstring date-time

Added

updated_atstring date-time

Updated

Example response

{
  "id": 2401,
  "public_id": "rnR8sT",
  "survey_workflow_id": 410,
  "contact_id": 730,
  "status": "completed",
  "preview": false,
  "completed_at": "2026-10-22T12:03:00Z",
  "canceled_at": null,
  "created_at": "2026-10-22T12:01:00Z",
  "updated_at": "2026-10-22T12:03:00Z",
  "form_submissions": [
    {
      "id": 3101,
      "public_id": "sbU9vW",
      "form_id": 810,
      "contact_id": 730,
      "answers": [
        {
          "id": 5003,
          "public_id": "anD7eF",
          "field": {
            "id": 902,
            "public_id": "fdD3eF",
            "key": "channels",
            "label": "Which channels do you use?"
          },
          "entry": null,
          "selected_options": [
            {
              "id": 911,
              "public_id": "opG4hJ",
              "label": "Email"
            },
            {
              "id": 912,
              "public_id": "opK5mN",
              "label": "Social"
            }
          ],
          "created_at": "2026-10-22T12:03:00Z",
          "updated_at": "2026-10-22T12:03:00Z"
        },
        {
          "id": 5002,
          "public_id": "anB6cD",
          "field": {
            "id": 901,
            "public_id": "fdA2bC",
            "key": "business_goal",
            "label": "What is your goal?"
          },
          "entry": "Grow my consulting business",
          "selected_options": [],
          "created_at": "2026-10-22T12:02:00Z",
          "updated_at": "2026-10-22T12:02:00Z"
        },
        {
          "id": 5001,
          "public_id": "anA5bC",
          "field": {
            "id": 901,
            "public_id": "fdA2bC",
            "key": "business_goal",
            "label": "What is your goal?"
          },
          "entry": "Find more leads",
          "selected_options": [],
          "created_at": "2026-10-22T12:01:00Z",
          "updated_at": "2026-10-22T12:01:00Z"
        }
      ]
    }
  ]
}

Changes