---
title: "List vendor documents"
method: GET
path: "/vendor/documents"
tags: ["vendors"]
---

# List vendor documents

`GET /vendor/documents`

## Request

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

Returns a list of documents that have been uploaded against this vendor in chronological order of when they were uploaded.

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

## Query parameters

- `vendor_primary_hostname` string
- `page_token` string
- `page_size` integer

## Response `200`

Vendor documents

- GetVendorDocumentsResponsePayload
  - `documents` Document[]: The documents uploaded for this vendor.
    - `description` string: The description of the document.
    - `file_name` string: The file name of the uploaded document.
    - `id` integer: The document ID.
    - `uploaded_at` string, date-time: When the document was uploaded.
  - `next_page_token` string: The token to be used to retrieve the next page of results. Will not be returned if there are no more results.
  - `total_results` integer: The total number of vendors found.

## 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)