---
title: "DO01 - List all document types"
method: GET
path: "/api/documents"
tags: ["Platform Settings"]
---

# DO01 - List all document types

`GET /api/documents`

## Request

- Base URL: `https://your-instance.mirakl.net`
- URL: `https://your-instance.mirakl.net/api/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/documents/get.ts> (a function with typed inputs; its response is checked against the schema)

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

<div class="recommended-call-frequency">Recommended usage: Once per day</div>
<div class="max-call-frequency">Maximum usage: Once per day</div>
<div class="extension-title">Read More</div>

<ul><li><a href="https://help.mirakl.com/bundle/customers/page/topics/Mirakl/mmp/Operator/manage_docs/manage_order_and_seller_docs/display_order_documents_on_front.html">More context</a></li></ul><div class="extension-title">Localization</div>

<p>This resource supports <code>locale</code> parameter (<a href="#section/Locale">see documentation</a>)</p><p>Localized output fields will be highlighted with an icon: <span class="flag"></span></p></div>

## Query parameters

- `entities` string

## Response `200`

OK

- DO01Response200
  - `documents` DO01Response200Documents[], required: Document types
    - `code` string, required: Type code
    - `description` string, required: Type description
    - `entity` string, required: Entity type linked to the document type Enum: `"ORDER"`, `"SHOP"`
    - `label` string, required: <span>Type label </span><span title="This field is localized: its value uses the locale provided in the parameters" class="flag"></span>
    - `mime_types` string[]: Authorized mime types
    - `models` string[]: The list of platform models on which this document type is available. This field is only present for document types linked to a 'SHOP' entity.

---

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