---
title: "List documents"
method: GET
path: "/v2/documents"
tags: ["Documents"]
---

# List documents

`GET /v2/documents`

List all the uploaded documents for a specific entity ID and type.

## Query parameters

- `entityType` 'PNR' | 'COMPANY' | 'AIR_ITINERARY' | 'EVENT' | 'LOCATION_IMAGE' | 'AIR_COMMISSION_CONTRACT', required — Entity type against which the document is to uploaded.
- `entityId` string, required

## Response `200`

OK

- GetDocumentsResponse — Response containing a list of documents.
  - `documents` Document[], required — List of documents.
    - `url` string, required — S3 location of the document.
    - `documentId` string, uuid, required — Unique identifier of the document.
    - `documentMetadata` DocumentMetadata, required — Metadata related to document.
      - `documentType` 'BOARDING_PASS' | 'CONFIRMATION' | 'INVOICE' | 'VISA' | 'MISCELLANEOUS' | 'OTHERS' | 'TASK_PROCESSOR' | 'EVENT_COVER_IMAGE' | 'LOGO_IMAGE', required — Document type.
      - `entityType` 'PNR' | 'COMPANY' | 'AIR_ITINERARY' | 'EVENT' | 'LOCATION_IMAGE' | 'AIR_COMMISSION_CONTRACT', required — Entity type against which the document is to uploaded.
      - `entityId` string, required — Entity Id for the given entity type.
      - `entityMetadata` union, required — Metadata for associated entity of document.
        - object
          - `pnrMetadata` union — Metadata when document is associated to pnr entity.
            - object
              - …
            - object
              - …
          - `invoiceMetadata` object — Metadata associated with an invoice document.
            - `invoiceNumber` string, required
            - `invoiceType` 'SERVICE_FEE_INVOICE' | 'FARE_INVOICE' | 'GENERIC_INVOICE'
          - `travelType` 'AIR' | 'HOTEL' | 'CAR' | 'RAIL' | 'LIMO' | 'MISC' | 'ALL', required — Travel Type
        - object
          - `eventMetadata` EventEntityMetadata — Metadata when document is associated to an event.
            - `address` PostalAddress — Postal Address Details
              - …
      - `name` string, required — Document name.

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `404` — The specified resource was not found.

---

[API](https://skmtc.dev/spotnana/apis/document-api.md) · [All operations](https://skmtc.dev/spotnana/apis/document-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/spotnana/document-api/revisions/ee4283647426/schema)