GET All files

get

https://app.plugsign.com.br/api/docs

Este endpoint permite listar todos os arquivos.

Você pode aplicar filtros usando os parâmetros de query disponíveis abaixo para refinar os resultados conforme necessário.

A lista vem com 15 documentos por página (não há per_page), ordenada pela data de upload (sort: desc, padrão, ou asc). O filtro name é parcial (contém); file_name, document_key e folder são comparações exatas; as datas usam o formato Y-m-d.

A listagem pode ser servida de cache por alguns minutos; upload, edição, exclusão e assinatura invalidam o cache na hora.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

folder

int32

Id da pasta para busca dos documentos.

name

string

Nome do documento na plataforma (Pode ser parcial, Ex: "contr" vai retornar "contrato").

file_name

string

Nome do arquivo gerado pela plataforma (file_name), comparação exata.

document_key

string

A Document Key (Identificador único) do documento.

editted

string

enum

Se o documento já foi editado.

Allowed:

is_template

string

enum

Marca se o documento é um template ou um documento convencional.

Allowed:

uploaded_on

date

Documentos enviados em uma data específica (Y-m-d).

upload_date_ini

date

Data inicial (Y-m-d) do intervalo de upload. Sozinha, filtra até a data atual.

upload_date_end

date

Data final (Y-m-d) do intervalo de upload. Só é considerada junto com upload_date_ini.

sort

string

enum

Defaults to desc

asc → retorna do mais antigo para o mais recente (ordem crescente).
desc → retorna do mais recente para o mais antigo (ordem decrescente).

Allowed:

status

string

enum

Situação das solicitações do documento: Signed (todas assinadas), Unsigned (nenhuma assinada), Partial_Signed (assinadas e pendentes) ou Cancelled (canceladas/recusadas). Outro valor responde 422.

Allowed:

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

422Filtro status fora da lista