Get questionnaire by ID - Vanta Developer Hub

GET

/

customer-trust

/

questionnaires

/

{questionnaireId}

Get questionnaire by ID

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

import requests

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

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/{questionnaireId}', 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/{questionnaireId}",
  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/{questionnaireId}"

	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))

}

require 'uri'
require 'net/http'

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

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

{
  "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"
}

Authorizations

Authorization

string

header

required

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

Path Parameters

questionnaireId

string

required

Response

200 - application/json

Ok

id

string

required

displayName

string

required

type

enum<string>

required

Available options:

SPREADSHEET,

WEBSITE,

DOCUMENT

status

enum<string>

required

Available options:

APPROVED,

IN_PROGRESS,

IN_REVIEW,

READY_FOR_REVIEW,

WAITING_ON_ANSWERS,

ON_HOLD,

NO_LONGER_NEEDED,

COMPLETE,

ERROR,

EXTRACTING_QUESTIONS,

QUEUED_FOR_SECTION_EXTRACTION,

EXTRACTING_SECTIONS,

MAPPING_SECTIONS,

QUEUED_FOR_ANSWERING,

GENERATING_ANSWERS,

QUEUED_FOR_EXTRACTION,

PROCESSING,

QUEUED_FOR_PROCESSING,

WAITING_ON_COLUMN_SELECTION,

WAITING_ON_COLUMN_APPROVAL,

QUEUED_FOR_COLUMN_DETECTION,

DETECTING_COLUMNS

statusLog

object[]

required

The status change history log for the questionnaire. Entries are ordered by the most recent status change first.

Show child attributes

tagAndCategoryIds

object[]

required

Tags assigned to this questionnaire. Each entry contains a categoryId and tagId.

Show child attributes

createdDate

string<date-time>

required

updatedDate

string<date-time>

required

url

string

ownerAssignment

object

The owner assignment in actor form (User or Team).

Show child attributes

approverAssignment

object

The approver assignment in actor form (User or Team).

Show child attributes

customerTrustAccountId

string

dueDate

string<date-time>

metadata

object[]

Show child attributes

completedDate

string<date-time>

⌘I

Get questionnaire by ID

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

import requests

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

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/{questionnaireId}', 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/{questionnaireId}",
  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/{questionnaireId}"

	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))

}

require 'uri'
require 'net/http'

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

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

{
  "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"
}