---
title: "List all document types"
method: GET
path: "/v1/document_types"
tags: ["Document check"]
---

# List all document types

`GET /v1/document_types`

Returns a list of all document types created in your Dotfile workspace.

---

#### See also  
Learn more about [Document check](./document-checks-guide)

## Query parameters

- `label` string
- `key` string
- `created_at` string — Date (`yyyy-MM-dd` eg `2023-01-31`) or date time (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`) in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
- `updated_at` string — Date (`yyyy-MM-dd` eg `2023-01-31`) or date time (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`) in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
- `include_archived` boolean
- `sort` string
- `page` number
- `limit` number

## Response `200`

List of document types created in the workspace

**ℹ️ Click to see full payload**

- DocumentTypeList
  - `data` CustomDocumentType[], required
    - `id` string, uuid, required
    - `label` string, required
    - `key` string, required — Unique identifier key. Format `/^[a-z][a-z_0-9]*$/` Must be unique
    - `target_entities` string[], required
    - `is_internal` boolean, required
    - `created_at` string, date-time, required — Creation date Date time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)
    - `updated_at` string, date-time, required — Latest update date Date time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)
    - `archived_at` string, date-time, nullable, required — Archival date Date time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)
  - `pagination` Pagination, required
    - `page` number, required — Current page number (defined in query parameter)
    - `limit` number, required — Item count per page (defined in query parameter)
    - `count` number, required — Total items count

## Other responses

- `400` — The request is either malformed or contain invalid parameters. - One or multiple filtering parameters might be malformed. Make sure to use a supported operator and value for each filter. - If specified, make sure the value of the `page` or `limit` query parameter are valid. - Value of the `sort` parameter is invalid. Make sure the field name is supported, the sorting order is correctly specified, and a same field is not used multiple times for sorting.

---

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