---
title: "Get vendor assessment details"
method: GET
path: "/vendor/assessment"
tags: ["vendors"]
---

# Get vendor assessment details

`GET /vendor/assessment`

## Request

- Base URL: `https://cyber-risk.upguard.com/api/public`
- URL: `https://cyber-risk.upguard.com/api/public/vendor/assessment`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/upguard/apis/upguard-cyberrisk-api/docs/vendor/assessment/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns detailed information about a specific vendor assessment version,
including assessment metadata, text sections, and evidence summaries.

Note: use /api/public/vendor/security_profile/assessment instead for security profile assessments.

Required API key permissions: `VendorRisk` (select when creating API key in Account Settings)

## Query parameters

- `id` integer, required
- `version_number` integer

## Response `200`

Vendor assessment details

- GetVendorAssessmentResponsePayload
  - `assessment` Assessment
    - `assessment_id` integer: The Assessment ID this version belongs to.
    - `author_email` string: The email address of the author who created this version.
    - `author_name` string: The name of the author who created this version.
    - `can_autofill` boolean: Indicates whether this assessment can use AI autofill.
    - `created_at` string: The date when this version was created.
    - `for_security_profile` boolean: Indicates whether this is a security profile assessment.
    - `hide_rating` boolean: Indicates whether the rating should be hidden.
    - `id` integer: The unique identifier for this assessment version.
    - `include_waivers` boolean: Indicates whether this assessment includes risk waivers.
    - `include_website_risks` boolean: Indicates whether this assessment includes website scanning risks.
    - `name` string: The name of the assessment.
    - `published_at` string: The date when this version was published. Will be null if not yet published.
    - `sections` AssessmentSection[]: The text sections of this assessment. Each section has a name and content. Only includes published sections.
      - `content` string: The text content of the section
      - `hidden` boolean: Whether the section is hidden from the published assessment. Omitted for sections whose visibility cannot be changed.
      - `name` string: The name of the section (e.g., "introduction", "background", "findings", "conclusion")
      - `section_id` string: The ID of the section. For assessments that use autofill sections this is `executive_summary`, `background`, `conclusion`, or a control domain ID such as `SP` or `iso27001/5`. For other assessments this is the same as `name`.
    - `status` string: The current status of this assessment. Possible values: draft, published, cancelled
    - `updated_at` string: The date when this version was last updated.
    - `version_number` integer: The version number of this assessment.
  - `evidence` AssessmentEvidence
    - `additional` AdditionalEvidence[]: Additional evidence documents
      - `commentary` string: Commentary on this evidence.
      - `created_at` string: Date when the evidence was uploaded.
      - `document_type` string: The document type.
      - `filename` string: The filename of the document.
      - `id` integer: The evidence ID.
      - `name` string: The name of the evidence.
      - `num_risks` integer: Number of risks identified in this evidence.
      - `selected` boolean: Indicates whether this evidence is selected.
    - `num_active_risk_waivers` integer: Number of active risk waivers
    - `num_risk_waivers` integer: Total number of risk waivers
    - `num_scanning_risks` integer: Number of website scanning risks included
    - `num_unapproved_risk_waivers` integer: Number of unapproved risk waivers
    - `shared_additional` PublicAdditionalEvidence[]: Shared additional evidence from a vendors trust page
      - `accessible` boolean: Indicates whether this shared evidence is accessible.
      - `commentary` string: Commentary on this evidence.
      - `created_at` string: Date when the evidence was uploaded.
      - `document_type` string: The document type.
      - `filename` string: The filename of the document.
      - `id` integer: The evidence ID.
      - `name` string: The name of the evidence.
      - `num_risks` integer: Number of risks identified in this evidence.
      - `selected` boolean: Indicates whether this evidence is selected.
      - `uuid` string: The UUID of the public evidence.
    - `shared_surveys` PublicSurveyEvidence[]: Shared questionnaires from a vendors trust page
      - `accessible` boolean: Indicates whether this shared questionnaire is accessible.
      - `id` integer: The questionnaire ID.
      - `last_answered_at` string: Date when the questionnaire was last answered.
      - `name` string: The name of the questionnaire.
      - `num_answers` integer: Number of answered questions.
      - `num_questions` integer: Number of questions in the questionnaire.
      - `num_risks` integer: Number of active risks identified.
      - `num_waivers` integer: Number of waivers applied.
      - `score` number, double: The score calculated from the questionnaire responses.
      - `selected` boolean: Indicates whether this questionnaire is selected as evidence.
      - `state` string: The current state of the questionnaire.
      - `type` string: The type of questionnaire.
    - `surveys` SurveyEvidence[]: Questionnaires used as evidence
      - `id` integer: The questionnaire ID.
      - `last_answered_at` string: Date when the questionnaire was last answered.
      - `name` string: The name of the questionnaire.
      - `num_answers` integer: Number of answered questions.
      - `num_questions` integer: Number of questions in the questionnaire.
      - `num_risks` integer: Number of active risks identified.
      - `num_waivers` integer: Number of waivers applied.
      - `score` number, double: The score calculated from the questionnaire responses.
      - `selected` boolean: Indicates whether this questionnaire is selected as evidence.
      - `state` string: The current state of the questionnaire.
      - `type` string: The type of questionnaire.

## Other responses

- `422`: An invalid parameter was supplied or a mandatory parameter was missing
- `429`: Too many requests have been made to this endpoint.
- `500`: An internal system error occurred

---

[API](https://skmtc.dev/upguard/apis/upguard-cyberrisk-api.md) - [All operations](https://skmtc.dev/upguard/apis/upguard-cyberrisk-api/llms.txt) - [OpenAPI document](https://skmtc.dev/upguard/apis/upguard-cyberrisk-api/revisions/d044bf6dc61e?raw)