Skip to main content
GET
Returns the catalog of questions that can be referenced from a given position in the study — with ready-to-insert {{Q:...}} templates for each. Use this endpoint to build an ”@-mention” picker or discover the exact token for one option response. Always copy the returned template into the destination question’s content. A full-answer token such as {{Q:<question_id>}} inserts the complete response. To insert one item from a structured answer, choose an entry whose kind is property.
string
required
The study ID.
string
Only return questions that appear before this question — use when editing an existing question.
integer
Only return the questions at zero-based interview positions lower than this value — use when composing a new question. Positions count questions in the order participants see them, with question groups expanded, so they match the numbers in the study editor. Ignored if before_question_id is set.

Supported question types

The following source question types can be mentioned:
  • textInput, shortText, number, and multipleChoice — full answer only.
  • matrixRatingScale — full answer or ratingForItem[index], which returns the rating for one item.
  • ranking — full answer, rankOfOption[index], or optionAtRank[index].
  • allocation — full answer or allocationForItem[index].
  • cardSort — full answer, categoryForCard[index], or cardsInCategory[index].
Property indices are zero-based. For example, ratingForItem[0] selects the first entry in the matrix question’s props.options.
Property selectors are type-specific. There is no generic .option[index] selector, and multiple-choice questions expose only their full answer.

Response

ReferenceableQuestion[]
Each entry has question_id, display_order (zero-based interview position, groups expanded), type, content, a human-readable label such as Q2, and available_references.
string
fullAnswer for the complete response or property for one structured sub-answer.
string
The exact {{Q:...}} token to insert into the destination question’s content.
string | null
Type-specific selector such as ratingForItem, rankOfOption, or allocationForItem. Null for a full answer.
integer | null
Zero-based option, category, or rank-position index. Null for a full answer.
string | null
Human-readable option, category, or rank position selected by the property reference.