---
title: "S30 - List shop's documents"
method: GET
path: "/api/shops/documents"
tags: ["Stores"]
---

# S30 - List shop's documents

`GET /api/shops/documents`

## Request

- Base URL: `https://your-instance.mirakl.net`
- URL: `https://your-instance.mirakl.net/api/shops/documents`
- Auth: one of:
  - HTTP bearer
  - OAuth 2
    - Authorization code: `https://auth.mirakl.net/authorize`
    - Token URL: `https://auth.mirakl.net/oauth/token`
- TypeScript: <https://skmtc.dev/mirakl/apis/mirakl-catalog-manager-apis/docs/api/shops/documents/get.ts> (a function with typed inputs; its response is checked against the schema)

<div class="extension-title">Description</div>

You must specify at least one of the following parameters: <code>shop_ids</code>, <code>updated_since</code>

<div class="api-description-extension">
<div class="extension-title">Call Frequency</div>

<div class="recommended-call-frequency">Recommended usage: At each display of a page that includes documents from a store (for example: during the KYC process)</div>
<div class="max-call-frequency">Maximum usage: At each display of a page that includes documents from a store (for example: during the KYC process)</div>
</div>

## Query parameters

- `shop_ids` string
- `include_deleted` boolean
- `updated_since` string, date-time

## Response `200`

OK

- S30Response200
  - `shop_documents` S30Response200ShopDocuments[], required: The document details
    - `date_deleted` string, date-time: Document deleted date
    - `date_uploaded` string, date-time: Document uploaded date
    - `file_name` string, required: Document file name
    - `id` integer, required: Document identifier
    - `shop_id` integer, required: The id of the shop owning the document
    - `type` string, required: Document type code
  - `total_count` integer: Total number of documents

---

[API](https://skmtc.dev/mirakl/apis/mirakl-catalog-manager-apis.md) - [All operations](https://skmtc.dev/mirakl/apis/mirakl-catalog-manager-apis/llms.txt) - [OpenAPI document](https://skmtc.dev/mirakl/apis/mirakl-catalog-manager-apis/revisions/dd54ccb6550e?raw)