---
title: "List documents for a module/record"
method: GET
path: "/api/documents-test/"
tags: ["documents-test"]
---

# List documents for a module/record

`GET /api/documents-test/`

List documents for a specific module/record with status.

Translates VBA: PTQ_ListaDocsMerged

## Query parameters

- `id_modulo` integer, required — Module ID (4=Movimentos, 7=PV, 8=Faturas, 12=Cliente)
- `id_modulo_id` integer, required — Record ID within the module
- `tipodoc` integer, nullable — Filter by document type
- `search` string, nullable — Search in document name
- `include_suggestions` boolean — Include 'em falta' suggested documents

## Headers

- `x-api-token` string, nullable

## Response `200`

Successful Response

- DocumentListResponse — Response for document listing.
  - `items` DocumentListItem[], required
    - `ID` integer, nullable — NULL if document is 'em falta'
    - `Nome` string, nullable
    - `Tipodoc` integer, required
    - `tipo_doc_nome` string, nullable
    - `Data` string, date-time, nullable
    - `Byuser` integer, nullable
    - `pdf_url` string, nullable
    - `ID_doc_assinado` integer, nullable
    - `url_doc_assinado` string, nullable
    - `DataExpira` string, date-time, nullable
    - `status` string, required — 'carregado' or 'em falta'
    - `status_assinado` string, nullable — 'Por Assinar' if needs signature
    - `id_modulo` integer, nullable
    - `id_modulo_id` integer, nullable
  - `total` integer, required
  - `uploaded_count` integer, required — Number of uploaded documents
  - `missing_count` integer, required — Number of missing suggested documents

## Other responses

- `422` — Validation Error

---

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