Get framework codes for an audit - Vanta Developer Hub

GET

audits

{auditId}

framework-codes

TypeScript

import { Vanta } from "vanta-auditor-api-sdk";

const vanta = new Vanta({
  bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
});

async function run() {
  const result = await vanta.audits.getFrameworkCodes({
    auditId: "<id>",
  });

  console.log(result);
}

run();

{
  "frameworkCodes": [
    "CC1.1",
    "CC1.2",
    "CC1.3",
    "CC2.1",
    "CC2.2",
    "CC3.1",
    "CC3.2",
    "CC4.1",
    "CC4.2",
    "CC5.1",
    "CC5.2",
    "CC6.1",
    "CC6.2",
    "CC7.1",
    "CC7.2",
    "CC8.1",
    "CC8.2"
  ]
}

Authorizations

Authorization

string

header

required

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

Path Parameters

auditId

string

required

Response

200 - application/json

Framework codes response resource

frameworkCodes

string[]

required

Array of valid framework codes for the audit's framework (e.g., "CC6.1", "CC6.2"). These represent the different framework sections available for creating information requests.

List information requests for an auditRetrieves a paginated list of all information requests for an audit, enabling external audit management systems to display and track evidence requests. This endpoint always includes soft-deleted records (where `deletionDate !== null`). Clients should check the `deletionDate` field to identify and handle deleted records appropriately in their systems. This endpoint supports delta synchronization via the `changedSinceDate` parameter, allowing efficient polling for changes without retrieving the entire dataset. Pagination usage: 1. Make initial request with desired `pageSize` 2. Check `results.pageInfo.hasNextPage` to see if more data exists 3. If true, use `results.pageInfo.endCursor` as `pageCursor` in next request 4. Repeat until `hasNextPage` is false Delta sync usage: 1. Store the timestamp of your last sync 2. Pass that timestamp as `changedSinceDate` 3. Only requests created, modified, or deleted since that timestamp are returned 4. Process updates and soft-deletes by checking the `deletionDate` field 5. Update your last sync timestamp to the current time

⌘I

TypeScript

import { Vanta } from "vanta-auditor-api-sdk";

const vanta = new Vanta({
  bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
});

async function run() {
  const result = await vanta.audits.getFrameworkCodes({
    auditId: "<id>",
  });

  console.log(result);
}

run();

{
  "frameworkCodes": [
    "CC1.1",
    "CC1.2",
    "CC1.3",
    "CC2.1",
    "CC2.2",
    "CC3.1",
    "CC3.2",
    "CC4.1",
    "CC4.2",
    "CC5.1",
    "CC5.2",
    "CC6.1",
    "CC6.2",
    "CC7.1",
    "CC7.2",
    "CC8.1",
    "CC8.2"
  ]
}