Get Study Questions

This endpoint retrieves all questions for a specific study.

GET /api/public/studies/{study_id}/questions

Example Request

curl 'https://listenlabs.ai/api/public/studies/my-study/questions' \
-H 'x-api-key: <api_key>'

Response

{
  "questions": [
    {
      "id": "a1b2c3d4-0000-0000-0000-000000000001",
      "text": "What is your age range?",
      "is_screener": true,
      "question_number": 1,
      "type": "multiple_choice",
      "is_multi_select": false,
      "options": ["18-24", "25-34", "35-44", "45-54", "55+"],
      "concepts": []
    },
    {
      "id": "a1b2c3d4-0000-0000-0000-000000000002",
      "text": "Tell us about your experience with our product.",
      "is_screener": false,
      "question_number": 2,
      "type": "open_ended",
      "concepts": []
    },
    {
      "id": "a1b2c3d4-0000-0000-0000-000000000003",
      "text": "Rank the following features by importance.",
      "is_screener": false,
      "question_number": 3,
      "type": "ranking",
      "options": ["Ease of use", "Performance", "Price", "Customer support"],
      "concepts": []
    },
    {
      "id": "a1b2c3d4-0000-0000-0000-000000000004",
      "text": "Thank you for your feedback. We will now ask about your preferences.",
      "is_screener": false,
      "question_number": 4,
      "type": "statement",
      "concepts": []
    },
    {
      "id": "a1b2c3d4-0000-0000-0000-000000000005",
      "text": "Which categories interest you? Select all that apply.",
      "is_screener": false,
      "question_number": 5,
      "type": "multiple_choice",
      "is_multi_select": true,
      "options": ["Technology", "Health", "Finance", "Education", "Entertainment"],
      "concepts": []
    }
  ]
}

Path Parameters

study_id · string · required

The unique ID of the study you want to retrieve questions for.

Response

Returns an object containing a list of questions from the study’s latest revision. Each question includes its type and relevant metadata.

questions · array

An array of question objects. Each question has a type field that determines its shape.

Show Question Types

Common Fields

All question types share these base fields:

id · string

Unique identifier for the question. Matches the discussion_guide_question_id field in the response endpoints, enabling you to join questions with their corresponding transcript rows and answers.

text · string

The question text shown to participants.

is_screener · boolean

Whether this question is part of the screening section.

type · string

The question type. One of: open_ended, multiple_choice, ranking, statement.

question_number · number

The human-readable question number for display purposes.

concepts · array

An array of concept objects attached to this question (empty if the question is not part of a concept test block).

Show Concept Object

id · string

Unique identifier for the concept.

title · string

The concept title.

description · string

The concept description.

media · array

An array of media attachments.

Show Media Object

type · string

The media type. One of: image, video.

name · string

The file name of the media.

url · string

The URL of the media file.

embed_url · string | null

An optional embed URL for the concept (e.g. a Figma or prototype link).

Multiple Choice Questions

Multiple choice questions (including scale questions) additionally include:

is_multi_select · boolean

Whether the participant can select multiple options.

options · string[]

The list of answer options.

Ranking Questions

Ranking questions additionally include:

options · string[]

The list of items to rank.

Example Request

curl 'https://listenlabs.ai/api/public/studies/my-study/questions' \
-H 'x-api-key: <api_key>'

Response

{
  "questions": [
    {
      "id": "a1b2c3d4-0000-0000-0000-000000000001",
      "text": "What is your age range?",
      "is_screener": true,
      "question_number": 1,
      "type": "multiple_choice",
      "is_multi_select": false,
      "options": ["18-24", "25-34", "35-44", "45-54", "55+"],
      "concepts": []
    },
    {
      "id": "a1b2c3d4-0000-0000-0000-000000000002",
      "text": "Tell us about your experience with our product.",
      "is_screener": false,
      "question_number": 2,
      "type": "open_ended",
      "concepts": []
    },
    {
      "id": "a1b2c3d4-0000-0000-0000-000000000003",
      "text": "Rank the following features by importance.",
      "is_screener": false,
      "question_number": 3,
      "type": "ranking",
      "options": ["Ease of use", "Performance", "Price", "Customer support"],
      "concepts": []
    },
    {
      "id": "a1b2c3d4-0000-0000-0000-000000000004",
      "text": "Thank you for your feedback. We will now ask about your preferences.",
      "is_screener": false,
      "question_number": 4,
      "type": "statement",
      "concepts": []
    },
    {
      "id": "a1b2c3d4-0000-0000-0000-000000000005",
      "text": "Which categories interest you? Select all that apply.",
      "is_screener": false,
      "question_number": 5,
      "type": "multiple_choice",
      "is_multi_select": true,
      "options": ["Technology", "Health", "Finance", "Education", "Entertainment"],
      "concepts": []
    }
  ]
}