Skip to content

List knowledge base items

GET
/api/v1/knowledge_base_items

Newest first. Discarded items are never returned. An unrecognised state value is ignored rather than rejected.

NameType
page
integer
default: 1 >= 1

Page number; 20 records per page

state
string
Allowed values: new ready_to_answer applicability_checked references_fetched needs_input auto_answered approved

Filter by state

200

Items

Response body
Media typeapplication/json
object
knowledge_base_items
Array<object>
object
id
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
id
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

to
integer | null

1-based index of the last record on this page