Search knowledge base items

GET

/api/v1/knowledge_base_items/search

PostgreSQL full-text search across each item’s question and answer, with prefix matching and any-word matching. language selects the stemming dictionary; an unsupported value falls back to english. Results are paginated like the list endpoint.

Authorizations

bearerAuth

Query Parameters

NameType

query

required

string

The search term

language

string

default: english

Allowed values: english spanish french german italian portuguese

page

integer

default: 1 >= 1

Page number; 20 records per page

Responses

200

Matching items

Response body

application/json

object

knowledge_base_items

Array<object>

object

string

web_link

string format: uri

The item’s page in the web app

question

string

answer

string | null

state

string

Allowed values: new ready_to_answer applicability_checked references_fetched needs_input auto_answered approved

Lifecycle state. approved items are used to answer questionnaires.

applicable

boolean | null

Whether the question applies to your organisation

rationale

string | null

auto_answer

boolean

Whether the AI may answer or re-answer this item

answer_detail_level

string

Allowed values: low normal high

confidence

string | null

0–1, encoded as a decimal string

confidence_as_words

string

Allowed values: Excellent Very good Good Ok Low

language

string

framework

string | null

Allowed values: nist-csf-2.0 hecvat-3.06 hecvat-4.1 rh-1.0 cjis-5 cjis-6

requires_attention

boolean

The confidence rating flagged points a human should review

category

object

integer

Numeric category ID, as accepted by category_id

name

string

area

string | null

created_at

string format: date-time

updated_at

string format: date-time

pagination

object

current_page

integer

total_pages

integer

total_count

integer

items_per_page

integer

from

integer | null

1-based index of the first record on this page

integer | null

1-based index of the last record on this page

400

A required parameter is missing

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/knowledge_base_items/search?query=example&language=english&page=1' \
  --header 'Authorization: Bearer <token>'

require 'uri'
require 'net/http'

url = URI("https://app.responsehub.io/api/v1/knowledge_base_items/search?query=example&language=english&page=1")

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/knowledge_base_items/search?query=example&language=english&page=1', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();

const url = 'https://app.responsehub.io/api/v1/knowledge_base_items/search?query=example&language=english&page=1';
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/knowledge_base_items/search?query=example&language=english&page=1"

  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

{
  "knowledge_base_items": [
    {
      "id": "kbi_1a2b",
      "web_link": "https://example.com",
      "question": "example",
      "answer": "example",
      "state": "new",
      "applicable": true,
      "rationale": "example",
      "auto_answer": true,
      "answer_detail_level": "low",
      "confidence": "0.85",
      "confidence_as_words": "Excellent",
      "language": "english",
      "framework": "nist-csf-2.0",
      "requires_attention": true,
      "category": {
        "id": 1,
        "name": "example",
        "area": "example"
      },
      "created_at": "2026-04-15T12:00:00Z",
      "updated_at": "2026-04-15T12:00:00Z"
    }
  ],
  "pagination": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 1,
    "items_per_page": 20,
    "from": 1,
    "to": 1
  }
}

400example

Example^generated

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