SurveyWorkflow

Fetch a survey with every current question on every branch, including questions nobody has answered yet. Edit labels and choices through the linked Form resources; see the Forms and surveys guide.

get/survey_workflows/{id}

Request

Path parameters

idstring required

Numeric ID or public_id.

Response

OK

idinteger

Survey ID

public_idstring nullable

Public ID

namestring nullable

Survey name

site_idinteger

Site ID

form_idinteger nullable

ID of the form that stores the survey's answers

enabledboolean

True when the survey is enabled

archivedstring date-time nullable

Archive timestamp; null when not archived.

created_atstring date-time

Added

updated_atstring date-time

Updated

Example response

{
  "id": 410,
  "public_id": "svQ7nP",
  "name": "Business goals",
  "site_id": 42,
  "form_id": 810,
  "enabled": true,
  "archived": null,
  "created_at": "2026-10-20T09:00:00Z",
  "updated_at": "2026-10-21T10:00:00Z",
  "questions": [
    {
      "id": 1201,
      "public_id": "qsM9kL",
      "type": "text",
      "title": "What is your goal?",
      "field_set_id": 900,
      "fields": [
        {
          "id": 901,
          "public_id": "fdA2bC",
          "key": "business_goal",
          "label": "What is your goal?",
          "field_type": "text",
          "allow_multiple": false,
          "captured_contact_attribute": null,
          "options": []
        }
      ]
    },
    {
      "id": 1202,
      "public_id": "qsP4rT",
      "type": "choice",
      "title": "Which channels do you use?",
      "field_set_id": 900,
      "fields": [
        {
          "id": 902,
          "public_id": "fdD3eF",
          "key": "channels",
          "label": "Which channels do you use?",
          "field_type": "choice",
          "allow_multiple": true,
          "captured_contact_attribute": null,
          "options": [
            {
              "id": 911,
              "public_id": "opG4hJ",
              "label": "Email",
              "image": null
            },
            {
              "id": 912,
              "public_id": "opK5mN",
              "label": "Social",
              "image": null
            }
          ]
        }
      ]
    }
  ]
}

Changes