curl 'https://listenlabs.ai/api/public/studies/my-study/questions' \
-H 'x-api-key: <api_key>'
{
"questions": [
{
"id": "a1b2c3d4-0000-0000-0000-000000000001",
"text": "What is your age range?",
"is_screener": true,
"type": "multiple_choice",
"is_multi_select": false,
"options": ["18-24", "25-34", "35-44", "45-54", "55+"]
},
{
"id": "a1b2c3d4-0000-0000-0000-000000000002",
"text": "Tell us about your experience with our product.",
"is_screener": false,
"type": "open_ended"
},
{
"id": "a1b2c3d4-0000-0000-0000-000000000003",
"text": "Rank the following features by importance.",
"is_screener": false,
"type": "ranking",
"options": ["Ease of use", "Performance", "Price", "Customer support"]
},
{
"id": "a1b2c3d4-0000-0000-0000-000000000004",
"text": "Thank you for your feedback. We will now ask about your preferences.",
"is_screener": false,
"type": "statement"
},
{
"id": "a1b2c3d4-0000-0000-0000-000000000005",
"text": "Which categories interest you? Select all that apply.",
"is_screener": false,
"type": "multiple_choice",
"is_multi_select": true,
"options": ["Technology", "Health", "Finance", "Education", "Entertainment"]
}
]
}
Endpoints
Get Study Questions
This endpoint retrieves all questions for a specific study.
GET
/
api
/
public
/
studies
/
{study_id}
/
questions
curl 'https://listenlabs.ai/api/public/studies/my-study/questions' \
-H 'x-api-key: <api_key>'
{
"questions": [
{
"id": "a1b2c3d4-0000-0000-0000-000000000001",
"text": "What is your age range?",
"is_screener": true,
"type": "multiple_choice",
"is_multi_select": false,
"options": ["18-24", "25-34", "35-44", "45-54", "55+"]
},
{
"id": "a1b2c3d4-0000-0000-0000-000000000002",
"text": "Tell us about your experience with our product.",
"is_screener": false,
"type": "open_ended"
},
{
"id": "a1b2c3d4-0000-0000-0000-000000000003",
"text": "Rank the following features by importance.",
"is_screener": false,
"type": "ranking",
"options": ["Ease of use", "Performance", "Price", "Customer support"]
},
{
"id": "a1b2c3d4-0000-0000-0000-000000000004",
"text": "Thank you for your feedback. We will now ask about your preferences.",
"is_screener": false,
"type": "statement"
},
{
"id": "a1b2c3d4-0000-0000-0000-000000000005",
"text": "Which categories interest you? Select all that apply.",
"is_screener": false,
"type": "multiple_choice",
"is_multi_select": true,
"options": ["Technology", "Health", "Finance", "Education", "Entertainment"]
}
]
}
Path Parameters
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.An array of question objects. Each question has a
type field that determines its shape.Show Question Types
Show Question Types
Common Fields
All question types share these base fields: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.The question text shown to participants.
Whether this question is part of the screening section.
The question type. One of:
open_ended, multiple_choice, ranking, statement.Multiple Choice Questions
Multiple choice questions (including scale questions) additionally include:Whether the participant can select multiple options.
The list of answer options.
Ranking Questions
Ranking questions additionally include:The list of items to rank.
curl 'https://listenlabs.ai/api/public/studies/my-study/questions' \
-H 'x-api-key: <api_key>'
{
"questions": [
{
"id": "a1b2c3d4-0000-0000-0000-000000000001",
"text": "What is your age range?",
"is_screener": true,
"type": "multiple_choice",
"is_multi_select": false,
"options": ["18-24", "25-34", "35-44", "45-54", "55+"]
},
{
"id": "a1b2c3d4-0000-0000-0000-000000000002",
"text": "Tell us about your experience with our product.",
"is_screener": false,
"type": "open_ended"
},
{
"id": "a1b2c3d4-0000-0000-0000-000000000003",
"text": "Rank the following features by importance.",
"is_screener": false,
"type": "ranking",
"options": ["Ease of use", "Performance", "Price", "Customer support"]
},
{
"id": "a1b2c3d4-0000-0000-0000-000000000004",
"text": "Thank you for your feedback. We will now ask about your preferences.",
"is_screener": false,
"type": "statement"
},
{
"id": "a1b2c3d4-0000-0000-0000-000000000005",
"text": "Which categories interest you? Select all that apply.",
"is_screener": false,
"type": "multiple_choice",
"is_multi_select": true,
"options": ["Technology", "Health", "Finance", "Education", "Entertainment"]
}
]
}
⌘I