---
title: "GET File Report"
method: GET
path: "/api/files/reports"
---

# GET File Report

`GET /api/files/reports`

Retorna um relatório detalhado dos arquivos disponíveis na plataforma, com suporte a filtros por chave de documento e nome do arquivo.

## Query parameters

- `document_key` string
- `name` string
- `start_date` string
- `end_date` string

## Response `200`

200

- object
  - `data` object[] — Objeto com o relatório detalhado dos arquivos.
    - `document_key` string — Chave única de identificação do documento.
    - `name` string — Nome do arquivo na plataforma.
    - `status` string — Status do arquivo.
    - `total_requests` integer — Total de solicitações de assinatura vinculadas ao documento.
    - `signed` integer — Quantidade de solicitações já assinadas.
    - `pending` integer — Quantidade de solicitações ainda pendentes de assinatura.
  - `links` object — Links de navegação da paginação.
    - `first` string — URL da primeira página.
    - `last` string — URL da última página.
    - `prev` string — URL da página anterior, ou null se não houver.
    - `next` string — URL da próxima página, ou null se não houver.
  - `meta` object — Informações de paginação.
    - `current_page` integer — Número da página atual.
    - `from` integer — Índice do primeiro item da página atual.
    - `last_page` integer — Número da última página.
    - `links` object[] — Lista de links de navegação da paginação.
      - `url` string — URL da página correspondente ao link de navegação.
      - `label` string — Texto exibido no link de paginação.
      - `active` boolean — Indica se este link representa a página atual.
    - `path` string — URL base da paginação.
    - `per_page` integer — Quantidade de itens por página.
    - `to` integer — Índice do último item da página atual.
    - `total` integer — Total de colaboradores cadastrados.

---

[API](https://skmtc.net/plugsign/apis/endpoints-manuais.md) · [All operations](https://skmtc.net/plugsign/apis/endpoints-manuais/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/plugsign/endpoints-manuais/revisions/41e10c7c691b/schema)