List snapshotted issues for an audit

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

The issues returned are immutable, point-in-time snapshots; there may be duplicates of issues that have been snapshotted at different times. The GET /audits//issues/snapshots endpoint can be used to retrieve metadata about the snapshots that issues belong to. Issues represent compliance findings from a variety of sources that need to be tracked and remediated.

Supports filtering by:

• search: full text search across issue title and description
• snapshotId: filtering to a specific snapshot or snapshots, which represent point-in-time captures of issues. Use the GET /audits//issues/snapshots endpoint to retrieve snapshot IDs and metadata.

Results are sorted by issue 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/items

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

  console.log(result);
}

run();

200

{
  "results": {
    "pageInfo": {
      "hasNextPage": false,
      "hasPreviousPage": false,
      "startCursor": null,
      "endCursor": null
    },
    "data": [
      {
        "id": "5f2c939a52855e725c8d5824",
        "title": "User accounts with weak passwords",
        "readableIssueId": "ISS-1234",
        "issueId": "5f2c939a52855e725c8d5825",
        "description": "The following user accounts have passwords that do not meet the company's password policy: [list of accounts]. Weak passwords increase the risk of unauthorized access to systems and data.",
        "snapshotId": "5f2c939a52855e725c8d5823",
        "dueDate": "2023-12-31T23:59:59.000Z",
        "status": "CLOSED",
        "lastModifiedAt": "2024-06-15T10:30:00.000Z",
        "createdAt": "2024-06-01T09:00:00.000Z",
        "detectedAt": "2024-05-30T14:45: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 issue title and description

snapshotIdMatchesAny · string[]

Filter issues to specific snapshots by snapshot ID

Response

200 - application/json

Ok

results · object · required

Show child attributes