Sign in

v1

latestOpenAPI 3.1.02026-08-041060342.7 KB

GET File Report

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

get/api/files/reports

Query parameters

document_keystring

Filtra os arquivos relacionados a uma chave de documento específica.

namestring

Filtra os arquivos pelo nome (parcial ou completo).

start_datestring

Data inicial para filtrar documentos pelo período de envio. Deve ser usado junto com end_date. Formato: Y-m-d.

end_datestring

Data final para filtrar documentos pelo período de envio. Deve ser usado junto com start_date. Formato: Y-m-d.

Response

200

Example response

{
  "data": [
    {
      "document_key": "d21Q7TIcdr6EW83Kz7ECP6bPakqMFVmM",
      "name": "SamplePdf (5)",
      "status": "partially_signed",
      "total_requests": 2,
      "signed": 1,
      "pending": 1
    }
  ],
  "links": {
    "first": "https://app.plugsign.com.br/api/files/reports?page=1",
    "last": "https://app.plugsign.com.br/api/files/reports?page=1"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "label": "« Previous"
      }
    ],
    "path": "https://app.plugsign.com.br/api/files/reports",
    "per_page": 15,
    "to": 1,
    "total": 1
  }
}