SurveyWorkflow

List a workspace's surveys, including disabled and archived ones. Each survey includes its current questions, the same as Fetch Survey. See the Forms and surveys guide.

get/workspaces/{workspace_id}/survey_workflows

Request

Path parameters

workspace_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.

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