List snapshotted issues for an audit

Retrieves a list of snapshots that have been shared with an audit.

The snapshots returned contain metadata about point-in-time captures of issues for an audit. This data can be used to filter down the list of issues to specific snapshots when querying the GET /audits//issues/items endpoint.

Supports filtering by:

• search: full text search across snapshot title and description

Results are sorted by snapshot creation date in descending order (newest first).

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

GET /audits/{auditId}/issues/snapshots

TypeScript

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

  console.log(result);
}

run();

200

{
  "results": {
    "pageInfo": {
      "hasNextPage": false,
      "hasPreviousPage": false,
      "startCursor": null,
      "endCursor": null
    },
    "data": [
      {
        "id": "5f2c939a52855e725c8d5823",
        "title": "Snapshot taken on 2024-06-01T00:00:00Z",
        "description": "This snapshot captures all open issues as of June 1st, 2024.",
        "createdAt": "2024-06-01T00:00: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.

search · string

Search term for filtering by snapshot title and description

Response

200 - application/json

Ok

results · object · required

Show child attributes