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
Rate limit: 10 requests / minute.
Path parameters
The audit ID
Query parameters
Controls the maximum number of items returned in one response from the API.
Maximum number of results per page (1-100, default 10)
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.
Pagination cursor from previous response
Response
Paginated list of risk snapshots with pagination metadata
Example response
{
"results": {
"data": [
{
"id": "507f1f77bcf86cd799439011"
}
]
}
}