GET All requests

get

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

Através deste endpoint, você pode obter os dados das solicitações já enviadas para assinatura, da mais recente para a mais antiga, com 50 por página (não há parâmetro per_page).

Filtros: id, signing_key, document, email e status são comparações exatas; documents[] recebe uma lista de document keys; folder aceita o id ou o nome da pasta; startDate e endDate (formato d-m-Y) devem ser enviadas juntas e filtram pela data de envio.

A listagem pode ser servida de cache por alguns minutos; criação, cancelamento e assinatura de solicitações invalidam o cache na hora.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

int32

ID da solicitação de assinatura.

status

string

enum

Status da solicitação de assinatura.

Allowed:

signing_key

string

Chave da solicitação de assinatura, para filtrar e obter apenas uma solicitação específica.

document

string

Document Key do documento, para obter todas as solicitações feitas para um doc específico.

documents

array of strings

Lista de document keys (documents[]=...&documents[]=...) para obter as solicitações de vários documentos.

documents

string

E-mail ou telefone do signatário (comparação exata).

startDate

string

Data inicial no formato d-m-Y (ex.: 01-10-2026). Obrigatória quando endDate é informada.

endDate

string

Data final no formato d-m-Y, igual ou posterior a startDate. Obrigatória quando startDate é informada.

folder

string

Id ou nome de uma pasta que contenha documentos. Uma pasta sem documentos (ou inexistente) gera erro 500 atualmente.

Responses

500

Pasta informada em folder sem documentos ou inexistente (erro interno atual)

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 inválido (status fora da lista, datas fora do formato ou enviadas separadamente)