List an item's references

GET

/api/v1/questionnaires/{questionnaire_id}/questionnaire_items/{id}/references

Every reference the retrieval step surfaced, most relevant first. Not paginated. A reference with cited_text set was quoted in the answer.

Authorizations

bearerAuth

Path Parameters

NameType

questionnaire_id

required

string

Example

qu_1a2b

The questionnaire’s prefixed ID

required

string

The record’s prefixed ID

Responses

200

References

Response body

application/json

object

references

Array<object>

A knowledge base item or source passage retrieved for an answer

object

integer

Numeric database ID

reference_type

string

Allowed values: KnowledgeBaseItem Embedding

reference_id

integer

Numeric database ID of the referenced record

relevance_score

number | null

<= 1

relevance_as_words

string

Allowed values: Excellent Very good Good Ok Low

distance

number | null

Vector distance from the question

search_method

string | null

Allowed values: vector keyword hybrid

cited_text

string | null

The passage quoted in the answer, when it was used

created_at

string format: date-time

reference

One of:

object
object

Present when reference_type is KnowledgeBaseItem

object

string

web_link

string format: uri

question

string

answer

string | null

state

string

Allowed values: new ready_to_answer applicability_checked references_fetched needs_input auto_answered approved

Present when reference_type is Embedding

object

string

text

string

The passage text

source_title

string | null

page

integer | null

Page of the source document

section

string | null

section_breadcrumb

string | null

Heading path to the section

404

No such record in this account

Response body

application/json

object

error

object

code

string

A stable machine-readable code

message

string

details

Array<string>

Present on validation errors; one entry per failed validation

Request

curl --request GET \
  --url https://app.responsehub.io/api/v1/questionnaires/qu_1a2b/questionnaire_items/example/references \
  --header 'Authorization: Bearer <token>'

require 'uri'
require 'net/http'

url = URI("https://app.responsehub.io/api/v1/questionnaires/qu_1a2b/questionnaire_items/example/references")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://app.responsehub.io/api/v1/questionnaires/qu_1a2b/questionnaire_items/example/references', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();

const url = 'https://app.responsehub.io/api/v1/questionnaires/qu_1a2b/questionnaire_items/example/references';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

package main

import (
  "fmt"
  "net/http"
  "io"
)

func main() {

  url := "https://app.responsehub.io/api/v1/questionnaires/qu_1a2b/questionnaire_items/example/references"

  req, _ := http.NewRequest("GET", url, nil)

  req.Header.Add("Authorization", "Bearer <token>")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

200example

Example^generated

{
  "references": [
    {
      "id": 1,
      "reference_type": "KnowledgeBaseItem",
      "reference_id": 1,
      "relevance_score": 1,
      "relevance_as_words": "Excellent",
      "distance": 1,
      "search_method": "vector",
      "cited_text": "example",
      "created_at": "2026-04-15T12:00:00Z",
      "reference": {
        "id": "kbi_1a2b",
        "web_link": "https://example.com",
        "question": "example",
        "answer": "example",
        "state": "new"
      }
    }
  ]
}

404example

Example^generated

{
  "error": {
    "code": "not_found",
    "message": "example",
    "details": [
      "example"
    ]
  }
}