References

List valid question mention templates

List the questions a question can reference, with insertable mention templates.

Mirrors the "@" picker in the Versive study editor: returns each previous, taggable question along with its full-answer reference and any property references, each carrying the exact {{Q:...}} template string to insert. Insert the returned template verbatim into the destination question's content.

Full-answer references ({{Q:<id>}}) are available for textInput, shortText, multipleChoice, matrixRatingScale, ranking, allocation, and cardSort. Structured property references are additionally available for:

  • matrixRatingScale: ratingForItem[index]
  • ranking: rankOfOption[index] and optionAtRank[index]
  • allocation: allocationForItem[index]
  • cardSort: categoryForCard[index] and cardsInCategory[index]

Property indices are zero-based. textInput, shortText, and multipleChoice expose only the full answer.

Only non-sensitive, author-owned fields are exposed (question IDs are intentionally included because templates require them).

get/api/v1/studies/{study_id}/available-references

Path parameters

study_idstring required

Query parameters

before_question_idstring nullable

Only return questions that appear before this question. Use when editing an existing question.

Only return questions that appear before this question. Use when editing an existing question.

before_display_orderinteger nullable

Only return questions with a display_order strictly less than this value. Use when composing a not-yet-created question.

Only return questions with a display_order strictly less than this value. Use when composing a not-yet-created question.

Response

Referenceable earlier questions and exact insertable mention templates.

Example response

{
  "references": [
    {
      "available_references": [
        {
          "template": "{{Q:question-id.ratingForItem[0]}}",
          "property_name": "ratingForItem",
          "option": "Speed"
        }
      ]
    }
  ]
}

Changes

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