Audits

List risk snapshots for an audit

Returns a paginated list of risk assessment snapshots available for an audit.

Risk snapshots capture the state of an organization’s risk register at a point in time. Each snapshot has an id that can be used with the /audits/{auditId}/risks endpoint to retrieve the individual risk scenarios within that snapshot.

Results are sorted by creation date (newest first). This sort order is fixed and cannot be customized via query parameters. Only snapshots that are shared with auditors are included.

Uses cursor-based pagination. To paginate:

Make initial request with desired pageSize
Check results.pageInfo.hasNextPage
Use results.pageInfo.endCursor as pageCursor for next request

GET

audits

{auditId}

risks

snapshots

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.listRiskSnapshots({
    auditId: "<id>",
  });

  console.log(result);
}

run();

{
  "results": {
    "pageInfo": {
      "hasNextPage": false,
      "hasPreviousPage": false,
      "startCursor": "507f1f77bcf86cd799439011",
      "endCursor": "507f1f77bcf86cd799439011"
    },
    "data": [
      {
        "id": "507f1f77bcf86cd799439011",
        "createdAt": "2024-08-15T14:30:00.000Z"
      }
    ]
  }
}

Authorizations

Authorization

string

header

required

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

Path Parameters

auditId

string

required

The audit ID

Query Parameters

pageSize

integer<int32>

default:10

Maximum number of results per page (1-100, default 10) Controls the maximum number of items returned in one response from the API.

Required range: 1 <= x <= 100

pageCursor

string

Pagination cursor from previous response 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.

Response

200 - application/json

Paginated list of risk snapshots with pagination metadata

results

object

required

Show child attributes

List risks for an auditRetrieves risk population data for an audit. This endpoint provides access to the risk records visible to auditors during an audit engagement. Risk data is scoped to a specific risk assessment snapshot identified by the `snapshotId` parameter. Only Controlled Audit View (CAV) audits are supported. Full Audit View audits are rejected with 403. Supports filtering by: - `search`: Searches risk scenario descriptions (case-insensitive) Results are sorted by identified date (newest first) by default. Use `orderBy` and `orderDirection` to customize sorting. Sort parameters must remain consistent across paginated requests. Uses cursor-based pagination. To paginate: 1. Make initial request with desired `pageSize` 2. Check `results.pageInfo.hasNextPage` 3. Use `results.pageInfo.endCursor` as `pageCursor` for next request

⌘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.listRiskSnapshots({
    auditId: "<id>",
  });

  console.log(result);
}

run();

{
  "results": {
    "pageInfo": {
      "hasNextPage": false,
      "hasPreviousPage": false,
      "startCursor": "507f1f77bcf86cd799439011",
      "endCursor": "507f1f77bcf86cd799439011"
    },
    "data": [
      {
        "id": "507f1f77bcf86cd799439011",
        "createdAt": "2024-08-15T14:30:00.000Z"
      }
    ]
  }
}