Search questionnaires

GET

/api/v1/questionnaires/search

Case-insensitive substring match. Newest first, paginated.

Authorizations

bearerAuth

Query Parameters

NameType

query

required

string

The search term

page

integer

default: 1 >= 1

Page number; 20 records per page

Responses

200

Matching questionnaires

Response body

application/json

object

questionnaires

Array<object>

object

string

web_link

string format: uri

The questionnaire’s page in the web app

title

string

description

string | null

deadline

string | null format: date

state

string

Allowed values: new qa_complete mapping_complete items_generated processing_items needs_input approved

Processing and review state

filetype

string | null

Allowed values: pdf xlsx docx

framework

string | null

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

portal_url

string | null format: uri

Set for questionnaires answered in a third-party portal

created_at

string format: date-time

updated_at

string format: date-time

owner

One of:

object
null

The member who owns or answered a record. id is the numeric database ID.

object

integer

name

string

email

string format: email

stats

Item counts. Discarded items are excluded.

object

total_items

integer

needs_input_items

integer

Items the AI could not answer confidently

auto_answered_items

integer

approved_items

integer

overall_completion_percentage

integer

<= 100

Approved items as a percentage of total

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

require 'uri'
require 'net/http'

url = URI("https://app.responsehub.io/api/v1/questionnaires/search?query=example&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/questionnaires/search?query=example&page=1', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();

const url = 'https://app.responsehub.io/api/v1/questionnaires/search?query=example&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/questionnaires/search?query=example&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

{
  "questionnaires": [
    {
      "id": "qu_1a2b",
      "web_link": "https://example.com",
      "title": "example",
      "description": "example",
      "deadline": "2026-04-15",
      "state": "new",
      "filetype": "pdf",
      "framework": "nist-csf-2.0",
      "portal_url": "https://example.com",
      "created_at": "2026-04-15T12:00:00Z",
      "updated_at": "2026-04-15T12:00:00Z",
      "owner": {
        "id": 1,
        "name": "example",
        "email": "hello@example.com"
      },
      "stats": {
        "total_items": 1,
        "needs_input_items": 1,
        "auto_answered_items": 1,
        "approved_items": 1,
        "overall_completion_percentage": 1
      }
    }
  ],
  "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"
    ]
  }
}