Get Knowledge Base resource

Fetch a single Knowledge Base resource (FILE or URL) by id. Returns the same type-discriminated union as the list endpoint, so callers can branch on type without knowing the kind ahead of time. Returns 404 when the resource does not exist in the domain or — for FILE rows — when the underlying uploaded document has been deleted.

GET /knowledge-base/resources/{id}

Get Knowledge Base resource

cURL

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

200

{
  "id": "507f1f77bcf86cd799439021",
  "type": "FILE",
  "title": "SOC 2 Type II Report",
  "description": "Annual SOC 2 Type II report covering 2024.",
  "fileUrl": "https://vanta-uploaded-documents.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"
}

Authorizations

Authorization · string · header · required

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

Path Parameters

id · string · required

Response

200 - application/json

Ok

Option 1

Option 2

Discriminated union over type of all resource kinds in the Trust Knowledge Base (currently FILE and URL).

id · string · required

type · enum<string> · required

Available options: FILE

title · string · required

description · string | null · required

fileUrl · string · required

Presigned S3 URL for the underlying document. Expires after 1 hour due to AWS IAM Role limitations on presigned URL lifetimes. Re-fetch the resource to obtain a fresh URL once this one expires.

customerVisibility · enum<string> | null · required

Available options: PRIVATE, SHAREABLE, REQUEST_ACCESS, PUBLIC, null

downloadPermission · enum<string> | null · required

Available options: VIEW_ONLY, VIEW_AND_DOWNLOAD, null

isUsedInQuestionnaires · boolean | null · required

ownerAssignment · object · required

Show child attributes

expirationStatus · enum<string> · required

Customer-facing expiration status used by knowledge-base API responses (answer library entries and resources). Derived from the persisted expiresAt field at read time.

Available options: CURRENT, EXPIRED

expirationDate · string | null · required

lastUpdated · string · required

lastVerified · string | null · required

tags · object[] · required

Show child attributes

categoryId · string | null · required

Trust Center category id the resource is currently filed under, or null if uncategorized (or not on the Trust Center, which is the case for PRIVATE / SHAREABLE resources).