> ## Documentation Index
> Fetch the complete documentation index at: https://developer.vanta.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List vendor document types

> Lists Vanta-provided and custom document types accepted by the vendor
document upload APIs.

Use the returned `type` value when uploading a vendor document. Use `id`
to save a mapping to a document type. For custom document types, the `id`
stays the same if the document type is renamed, while `name` and `type`
reflect the current name. Refresh this catalog before uploading documents
if custom document type names may have changed.

Results return Vanta-provided document types first, then custom document
types, with each group sorted by display name and ID. Custom document types
with names matching values reserved for Vanta-provided document types are
excluded because uploads would otherwise use the Vanta-provided type.



## OpenAPI

````yaml /reference/manage-vanta.json get /vendor-document-types
openapi: 3.0.0
info:
  title: Manage Vanta
  version: 1.0.0
  description: >-
    The REST API lets customers query and mutate Vanta's data. Use this API to
    automate bulk actions, query data for custom workflows and dashboards, and
    bolster your security operations


    **Note for Vanta Gov (FedRAMP) customers:** Select `Vanta Gov (FedRAMP)`
    from the server dropdown to issue requests against
    `https://api.vanta-gov.com`. The OAuth token URL shown below defaults to the
    commercial host — replace it with `https://api.vanta-gov.com/oauth/token`.
  termsOfService: https://www.vanta.com/terms
  license:
    name: UNLICENSED
  contact:
    name: API Support
    url: https://help.vanta.com/
    email: support@vanta.com
servers:
  - url: https://api.vanta.com/v1
    description: Vanta (Commercial)
  - url: https://api.vanta-gov.com/v1
    description: Vanta Gov (FedRAMP)
security: []
paths:
  /vendor-document-types:
    get:
      tags:
        - Vendor Document Types
      summary: List vendor document types
      description: >-
        Lists Vanta-provided and custom document types accepted by the vendor

        document upload APIs.


        Use the returned `type` value when uploading a vendor document. Use `id`

        to save a mapping to a document type. For custom document types, the
        `id`

        stays the same if the document type is renamed, while `name` and `type`

        reflect the current name. Refresh this catalog before uploading
        documents

        if custom document type names may have changed.


        Results return Vanta-provided document types first, then custom document

        types, with each group sorted by display name and ID. Custom document
        types

        with names matching values reserved for Vanta-provided document types
        are

        excluded because uploads would otherwise use the Vanta-provided type.
      operationId: ListVendorDocumentTypes
      parameters:
        - in: query
          name: pageSize
          required: false
          schema:
            $ref: '#/components/schemas/PageSize'
        - in: query
          name: pageCursor
          required: false
          schema:
            $ref: '#/components/schemas/PageCursor'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PaginatedResponse_VendorDocumentTypeCatalogEntry_
              examples:
                Example 1:
                  value:
                    results:
                      data:
                        - id: SOC2_REPORT
                          name: SOC 2 report
                          type: SOC2_REPORT
                          isCustom: false
                        - id: custom-doc-type-123
                          name: Security whitepaper
                          type: Security whitepaper
                          isCustom: true
                      pageInfo:
                        hasNextPage: false
                        hasPreviousPage: false
                        startCursor: U09DMl9SRVBPUlQ=
                        endCursor: Y3VzdG9tLWRvYy10eXBlLTEyMw==
      security:
        - bearerAuth: []
components:
  schemas:
    PageSize:
      type: integer
      format: int32
      default: 10
      description: >-
        Controls the maximum number of items returned in one response from the
        API.
      minimum: 1
      maximum: 100
    PageCursor:
      type: string
      description: >-
        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.
    PaginatedResponse_VendorDocumentTypeCatalogEntry_:
      properties:
        results:
          properties:
            data:
              items:
                $ref: '#/components/schemas/VendorDocumentTypeCatalogEntry'
              type: array
            pageInfo:
              $ref: '#/components/schemas/PageInfo'
          required:
            - data
            - pageInfo
          type: object
      required:
        - results
      type: object
      additionalProperties: false
    VendorDocumentTypeCatalogEntry:
      properties:
        id:
          type: string
          description: >-
            Unique identifier for the document type. Use this to save a mapping
            to a document type; use the `type` field when uploading a document.
        name:
          type: string
          description: Display name of the document type.
        type:
          type: string
          description: >-
            Value to provide in the `type` field when uploading a vendor
            document.
        isCustom:
          type: boolean
          description: Whether this document type was created by your organization.
      required:
        - id
        - name
        - type
        - isCustom
      type: object
      additionalProperties: false
    PageInfo:
      description: Provides information about the pagination of a dataset.
      properties:
        endCursor:
          type: string
          nullable: true
          description: >-
            The cursor that points to the end of the current page, or null if
            there is no such cursor.
        hasNextPage:
          type: boolean
          description: Indicates if there is another page after the current page.
        hasPreviousPage:
          type: boolean
          description: Indicates if there is a page before the current page.
        startCursor:
          type: string
          nullable: true
          description: >-
            The cursor that points to the start of the current page, or null if
            there is no such cursor.
      required:
        - endCursor
        - hasNextPage
        - hasPreviousPage
        - startCursor
      type: object
      additionalProperties: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````

## Related topics

- [List vendor documents](https://developer.vanta.com/api-reference/vendors/list-vendor-documents.md)
- [List security review documents](https://developer.vanta.com/api-reference/vendors/list-security-review-documents.md)
- [List vendor findings](https://developer.vanta.com/api-reference/vendors/list-vendor-findings.md)
- [List documents](https://developer.vanta.com/api-reference/documents/list-documents.md)
- [List a control's documents](https://developer.vanta.com/api-reference/controls/list-a-controls-documents.md)
