List comments for an information request

Retrieves a paginated list of comments for an information request, enabling auditors to view communication history and collaborate with customers.

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 comments created, modified, or deleted since that timestamp are returned
4. Process updates, including soft-deletes (deletionDate !== null)
5. Update your last sync timestamp to the current time

GET /audits/{auditId}/information-requests/{requestId}/comments

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

  console.log(result);
}

run();

200

{
  "results": {
    "data": [
      {
        "id": "65fc81a3359c8508c9af880f",
        "text": "Some comment",
        "creationDate": "2024-03-07T21:25:56.000Z",
        "modificationDate": "2024-03-07T21:25:56.000Z",
        "deletionDate": "2024-03-07T21:25:56.000Z",
        "email": "[e-mail]",
        "authorName": "Vlad Vantaroo"
      }
    ],
    "pageInfo": {
      "hasNextPage": false,
      "hasPreviousPage": false,
      "startCursor": "Njg5MGU0NzNkY2UxZGE1Z",
      "endCursor": "Njg5MGU0NzNkY2UxZGE1Z"
    }
  }
}

Authorizations

Authorization · string · header · required

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

Path Parameters

auditId · string · required

requestId · string · required

Query Parameters

pageSize · integer<int32> · default: 10

Maximum number of comments to return per page. Controls the maximum number of items returned in one response from the API.

Required range: 1 <= x <= 100

pageCursor · string

Pagination cursor from a previous response. Provide to fetch the next page of comments. 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.

changedSinceDate · string<date-time>

Includes all comments that have changed since changedSinceDate. Considers creationDate, modificationDate, and deletionDate timestamps when determining changes.

Response

200 - application/json

Ok

results · object · required

Show child attributes