Studies

List studies

Retrieve the studies accessible to the authenticated account, newest first. Optionally filter by account ID. Returns one page of limit studies (default 50); pass next_cursor back as cursor to read the next page.

get/api/v1/studies

Request

  • Base URL
    https://app.voicepanel.com
  • URL
    https://app.voicepanel.com/api/v1/studies
  • Auth
    HTTP bearer

Query parameters

accountIdstring
Example:acct_7Kq2mVbXpR4nZa

Filter studies by account ID

limitinteger

Page size (1-200). Defaults to 50. When has_more is true, pass next_cursor back as cursor to read the next page.

cursorstring

Opaque cursor from a previous page's next_cursor. Returns the rows after that position.

Response

Successful response

has_moreboolean required

True when rows exist after the last one in data

next_cursorstring nullable required

Pass back as cursor to read the next page

Example response

{
  "data": [
    {
      "id": "stdy_Qm3vR8tLp2XnWz",
      "account_id": "acct_7Kq2mVbXpR4nZa",
      "display_name": "Grocery delivery habits",
      "internal_name": "Q1 grocery delivery interviews",
      "objective": "Learn why shoppers try a grocery delivery app and what keeps them ordering.",
      "context": "Acme Fresh is a same-day grocery delivery app for city neighborhoods.",
      "plan": {
        "version": "2025_04",
        "sections": [
          {
            "intro": "First, a few questions about how you shop for groceries.",
            "steps": [
              {
                "question": "How often do you order groceries for delivery?",
                "type": "single_select",
                "options": [
                  {
                    "value": "Weekly or more",
                    "anchor": null,
                    "exclusive": null
                  },
                  {
                    "value": "A few times a month",
                    "anchor": null,
                    "exclusive": null
                  },
                  {
                    "value": "Rarely or never",
                    "anchor": null,
                    "exclusive": null
                  }
                ],
                "shuffle_options": false,
                "vertically_align_choices": null
              },
              {
                "question": "What made you try Acme Fresh for the first time?",
                "type": "long_question",
                "probing_type": "light",
                "probing_areas": null,
                "response_format": "audio"
              },
              {
                "question": "How likely are you to recommend Acme Fresh to a friend?",
                "type": "rating_scale",
                "options": [
                  {
                    "value": "1",
                    "anchor": null,
                    "exclusive": null
                  },
                  {
                    "value": "2",
                    "anchor": null,
                    "exclusive": null
                  },
                  {
                    "value": "3",
                    "anchor": null,
                    "exclusive": null
                  },
                  {
                    "value": "4",
                    "anchor": null,
                    "exclusive": null
                  },
                  {
                    "value": "5",
                    "anchor": null,
                    "exclusive": null
                  }
                ],
                "lowest_rating_label": "Not at all likely",
                "highest_rating_label": "Extremely likely"
              }
            ],
            "stimulus": null,
            "recording": null,
            "conditionalBranch": null
          }
        ],
        "randomizations": [],
        "device": "any"
      },
      "plan_source": "study.plan",
      "brand_logo_url": "https://cdn.example.com/acme-fresh/logo.png",
      "show_welcome_page": true,
      "welcome_text": "Thanks for taking part. You will talk with an AI interviewer about how you shop for groceries.",
      "target_length_min": 5,
      "written_in_language": "en-US",
      "authoring_method": "scratch",
      "source": "api",
      "last_edited_source": "api",
      "last_modified_at": "2026-03-02T15:10:00.000Z",
      "created_by": "0f1b3c6e-9d2a-4b7c-8e5f-2a1d4c6b8e90",
      "created_at": "2026-03-01T09:30:00.000Z",
      "updated_at": "2026-03-02T15:10:00.000Z",
      "tags": [
        {
          "id": "tag_4Hs8kPq1Lm2Zx7",
          "account_id": "acct_7Kq2mVbXpR4nZa",
          "name": "Q1 research",
          "created_at": "2026-02-10T12:00:00.000Z"
        }
      ],
      "distribution_count": 1,
      "computed_status": "collecting",
      "created_by_user": {
        "id": "0f1b3c6e-9d2a-4b7c-8e5f-2a1d4c6b8e90",
        "first_name": "Dana",
        "last_name": "Lee"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.