List questionnaires - Vanta Developer Hub

GET

customer-trust

questionnaires

List questionnaires

curl --request GET \
  --url https://api.vanta.com/v1/customer-trust/questionnaires \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.vanta.com/v1/customer-trust/questionnaires"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.vanta.com/v1/customer-trust/questionnaires', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.vanta.com/v1/customer-trust/questionnaires",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.vanta.com/v1/customer-trust/questionnaires"

	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(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.vanta.com/v1/customer-trust/questionnaires")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.vanta.com/v1/customer-trust/questionnaires")

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

{
  "results": {
    "data": [
      {
        "id": "507f1f77bcf86cd799439011",
        "displayName": "SOC 2 Security Questionnaire",
        "type": "SPREADSHEET",
        "status": "IN_PROGRESS",
        "statusLog": [],
        "dueDate": "2024-12-31T00:00:00.000Z",
        "metadata": [
          {
            "key": "priority",
            "value": "high"
          }
        ],
        "tagAndCategoryIds": [],
        "createdDate": "2024-12-01T00:00:00.000Z",
        "updatedDate": "2024-12-14T00:00:00.000Z"
      }
    ],
    "pageInfo": {
      "hasNextPage": false,
      "hasPreviousPage": false,
      "startCursor": "507f1f77bcf86cd799439011",
      "endCursor": "507f1f77bcf86cd799439011"
    }
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

pageSize

integer<int32>

default:10

Controls the maximum number of items returned in one response from the API.

Required range: 1 <= x <= 100

pageCursor

string

A marker or pointer, telling the API where to start fetching items for the subsequent page in a paginated dataset. Note that the requested page will not include the item that corresponds to this cursor but will start from the one immediately after this cursor.

string

Filter questionnaires by display name (case-insensitive, partial match).

statusMatchesAny

enum<string>[]

Filter questionnaires matching any of the provided statuses.

Available options:

APPROVED,

IN_PROGRESS,

IN_REVIEW,

READY_FOR_REVIEW,

WAITING_ON_ANSWERS,

ON_HOLD,

NO_LONGER_NEEDED,

COMPLETE,

ERROR,

EXTRACTING_QUESTIONS,

QUEUED_FOR_EXTRACTION,

PROCESSING,

QUEUED_FOR_PROCESSING,

WAITING_ON_COLUMN_SELECTION,

WAITING_ON_COLUMN_APPROVAL,

QUEUED_FOR_COLUMN_DETECTION,

DETECTING_COLUMNS

typeMatchesAny

enum<string>[]

Filter questionnaires matching any of the provided types.

Available options:

SPREADSHEET,

WEBSITE,

DOCUMENT

createdAfter

string

Filter to questionnaires created after this date (ISO 8601 string).

createdBefore

string

Filter to questionnaires created before this date (ISO 8601 string).

ownerIdMatchesAny

string[]

Filter to questionnaires owned by any of the provided user IDs.

approverIdMatchesAny

string[]

Filter to questionnaires with an approver matching any of the provided user IDs.

Response

200 - application/json

results

object

required

Show child attributes

List assignable usersList users who can be assigned as owner or approver on a questionnaire. When a role is specified, results are filtered to users with that role's required permission. When omitted, users assignable to either role are returned. Results can optionally be narrowed by a search string.

⌘I

List questionnaires

curl --request GET \
  --url https://api.vanta.com/v1/customer-trust/questionnaires \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.vanta.com/v1/customer-trust/questionnaires"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.vanta.com/v1/customer-trust/questionnaires', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.vanta.com/v1/customer-trust/questionnaires",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.vanta.com/v1/customer-trust/questionnaires"

	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(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.vanta.com/v1/customer-trust/questionnaires")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.vanta.com/v1/customer-trust/questionnaires")

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

{
  "results": {
    "data": [
      {
        "id": "507f1f77bcf86cd799439011",
        "displayName": "SOC 2 Security Questionnaire",
        "type": "SPREADSHEET",
        "status": "IN_PROGRESS",
        "statusLog": [],
        "dueDate": "2024-12-31T00:00:00.000Z",
        "metadata": [
          {
            "key": "priority",
            "value": "high"
          }
        ],
        "tagAndCategoryIds": [],
        "createdDate": "2024-12-01T00:00:00.000Z",
        "updatedDate": "2024-12-14T00:00:00.000Z"
      }
    ],
    "pageInfo": {
      "hasNextPage": false,
      "hasPreviousPage": false,
      "startCursor": "507f1f77bcf86cd799439011",
      "endCursor": "507f1f77bcf86cd799439011"
    }
  }
}