SurveyWorkflow::Run

List Full Survey Responses

Changed on

List every run of a survey, one per respondent, with every saved answer. Filter by status or contact_id. The survey_workflow_run.completed webhook sends the same run object. See the Forms and surveys guide.

get/survey_workflows/{survey_workflow_id}/runs

Request

Path parameters

survey_workflow_idstring required

Numeric ID or public_id.

Query parameters

afterstring

ID of item after which the collection should be returned. More examples and info about pagination in our guides.

per_pageinteger

Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.

sort_order'asc' | 'desc'

Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples in our guides.

sort_property'id' | 'updated_at'

Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

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

Derived run status.

contact_idstring

Comma-separated contact IDs.

Filter runs by status (one of active, paused, completed or canceled) and/or contact_id (comma-separated contact IDs). An unknown status returns 422.

{
  "status": "completed",
  "contact_id": "730"
}

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