Knowledge Base

List Knowledge Base resources

List Knowledge Base resources (documents and webpages) in a single paginated response. Each entry is a discriminated union on type — “FILE” entries carry a fileUrl (presigned S3 URL, valid for one hour), “URL” entries carry the resource’s url and includeSubPages.

Supports full-text search, type filtering, tag filtering (OR within a category, AND across categories), and date-range filters on last-updated and expiration.

Resources are returned most-recently-updated first.

GET

knowledge-base

resources

List Knowledge Base resources

curl --request GET \
  --url https://api.vanta.com/v1/knowledge-base/resources \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.vanta.com/v1/knowledge-base/resources', 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/knowledge-base/resources",
  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/knowledge-base/resources"

	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/knowledge-base/resources")

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": "507f1f77bcf86cd799439021",
        "type": "FILE",
        "title": "SOC 2 Type II Report",
        "description": "Annual SOC 2 Type II report covering 2024.",
        "fileUrl": "https://files.example.s3.amazonaws.com/507f1f77bcf86cd799439021?X-Amz-Expires=3600&X-Amz-Signature=...",
        "customerVisibility": "REQUEST_ACCESS",
        "downloadPermission": "VIEW_AND_DOWNLOAD",
        "isUsedInQuestionnaires": true,
        "ownerAssignment": {
          "type": "User",
          "id": "507f1f77bcf86cd799439041",
          "displayName": "Alex Rivera"
        },
        "expirationStatus": "CURRENT",
        "expirationDate": "2025-12-31T00:00:00.000Z",
        "lastUpdated": "2024-12-15T17:42:11.000Z",
        "lastVerified": "2024-12-20T09:00:00.000Z",
        "tags": [
          {
            "categoryId": "507f1f77bcf86cd799439011",
            "tagId": "507f1f77bcf86cd799439013"
          }
        ],
        "categoryId": "507f1f77bcf86cd799439051"
      },
      {
        "id": "507f1f77bcf86cd799439022",
        "type": "URL",
        "title": "Vanta Security Overview",
        "description": "Public-facing overview of Vanta's security posture.",
        "url": "https://www.vanta.com/security",
        "customerVisibility": "PUBLIC",
        "includeSubPages": true,
        "isUsedInQuestionnaires": true,
        "ownerAssignment": {
          "type": "User",
          "id": "507f1f77bcf86cd799439041",
          "displayName": "Alex Rivera"
        },
        "expirationStatus": "CURRENT",
        "expirationDate": "2025-08-01T00:00:00.000Z",
        "lastUpdated": "2024-11-04T13:21:55.000Z",
        "lastVerified": "2024-11-04T13:21:55.000Z",
        "tags": [
          {
            "categoryId": "507f1f77bcf86cd799439011",
            "tagId": "507f1f77bcf86cd799439014"
          }
        ],
        "categoryId": "507f1f77bcf86cd799439052"
      }
    ],
    "pageInfo": {
      "hasNextPage": false,
      "hasPreviousPage": false
    }
  }
}

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

Full-text search across resource titles.

typeMatchesAny

enum<string>[]

Filter to FILE and/or URL resources. Repeat the param to allow either.

Available options:

FILE,

URL

lastUpdatedAfter

string

Only include resources updated at or after this ISO 8601 timestamp.

lastUpdatedBefore

string

Only include resources updated at or before this ISO 8601 timestamp.

matchesTags

string

JSON-encoded array of {categoryId, tagId} pairs. Tags within the same category are OR'd together; tags across different categories are AND'd. For example, passing two tags from "Framework" and one tag from "Region" matches resources that have either of the two frameworks AND the given region. Discover valid categoryId and tagId values via GET /v1/customer-trust/tag-categories (to list categories) and GET /v1/customer-trust/tag-categories/{tagCategoryId} (to list tags within a category).

expiresBefore

string

Only include resources expiring at or before this ISO 8601 timestamp.

expiresAfter

string

Only include resources expiring at or after this ISO 8601 timestamp.

Response

200 - application/json

results

object

required

Show child attributes

⌘I

List Knowledge Base resources

curl --request GET \
  --url https://api.vanta.com/v1/knowledge-base/resources \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.vanta.com/v1/knowledge-base/resources', 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/knowledge-base/resources",
  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/knowledge-base/resources"

	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/knowledge-base/resources")

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": "507f1f77bcf86cd799439021",
        "type": "FILE",
        "title": "SOC 2 Type II Report",
        "description": "Annual SOC 2 Type II report covering 2024.",
        "fileUrl": "https://files.example.s3.amazonaws.com/507f1f77bcf86cd799439021?X-Amz-Expires=3600&X-Amz-Signature=...",
        "customerVisibility": "REQUEST_ACCESS",
        "downloadPermission": "VIEW_AND_DOWNLOAD",
        "isUsedInQuestionnaires": true,
        "ownerAssignment": {
          "type": "User",
          "id": "507f1f77bcf86cd799439041",
          "displayName": "Alex Rivera"
        },
        "expirationStatus": "CURRENT",
        "expirationDate": "2025-12-31T00:00:00.000Z",
        "lastUpdated": "2024-12-15T17:42:11.000Z",
        "lastVerified": "2024-12-20T09:00:00.000Z",
        "tags": [
          {
            "categoryId": "507f1f77bcf86cd799439011",
            "tagId": "507f1f77bcf86cd799439013"
          }
        ],
        "categoryId": "507f1f77bcf86cd799439051"
      },
      {
        "id": "507f1f77bcf86cd799439022",
        "type": "URL",
        "title": "Vanta Security Overview",
        "description": "Public-facing overview of Vanta's security posture.",
        "url": "https://www.vanta.com/security",
        "customerVisibility": "PUBLIC",
        "includeSubPages": true,
        "isUsedInQuestionnaires": true,
        "ownerAssignment": {
          "type": "User",
          "id": "507f1f77bcf86cd799439041",
          "displayName": "Alex Rivera"
        },
        "expirationStatus": "CURRENT",
        "expirationDate": "2025-08-01T00:00:00.000Z",
        "lastUpdated": "2024-11-04T13:21:55.000Z",
        "lastVerified": "2024-11-04T13:21:55.000Z",
        "tags": [
          {
            "categoryId": "507f1f77bcf86cd799439011",
            "tagId": "507f1f77bcf86cd799439014"
          }
        ],
        "categoryId": "507f1f77bcf86cd799439052"
      }
    ],
    "pageInfo": {
      "hasNextPage": false,
      "hasPreviousPage": false
    }
  }
}

API Basics

Manage API

Integrations API

Audit API

Webhooks

List Knowledge Base resources

Authorizations

Query Parameters

Response