---
title: "Get the summary for an assessment"
method: GET
path: "/api/v1/assessments/{id}/summary"
tags: ["client-api-assessment-rest-resource"]
---

# Get the summary for an assessment

`GET /api/v1/assessments/{id}/summary`

## Request

- Base URL: `https://app.visotrust.com`
- URL: `https://app.visotrust.com/api/v1/assessments/{id}/summary`
- Auth: none declared
- TypeScript: <https://skmtc.dev/visotrust/apis/viso-trust-api-documentation/docs/api/v1/assessments/:id/summary/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns the assessment summary as the stored HTML report by default. If the summary has been edited, the
edit is returned.

Pass `format=markdown` to get the same content as Markdown instead — headings, lists and tables are
preserved, but the markup and styling are not, so the summary can be read as text or fed to another
system without stripping HTML first.

## Path parameters

- `id` integer, required

## Query parameters

- `format` 'html' | 'markdown'

## Response `200`

OK

- AssessmentSummaryView
  - `id` integer: The assessment's identifier
  - `summary` string: The assessment summary, as HTML by default or as Markdown when 'format=markdown' is requested
  - `version` string: Identifies this revision of the summary. Pass it back when updating the summary to have the update rejected if the summary has changed in the meantime.
  - `edited` boolean: Whether the summary has been edited since it was generated

---

[API](https://skmtc.dev/visotrust/apis/viso-trust-api-documentation.md) - [All operations](https://skmtc.dev/visotrust/apis/viso-trust-api-documentation/llms.txt) - [OpenAPI document](https://skmtc.dev/visotrust/apis/viso-trust-api-documentation/revisions/98c8d5d102c9?raw)