GET All requests

Changed on Nov 3, 2026

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.

get/api/requests

Request

Base URL
https://app.plugsign.com.br
URL
https://app.plugsign.com.br/api/requests
Auth
API key in header Authorization

Query parameters

idinteger

ID da solicitação de assinatura.

status'Pending' | 'Signed' | 'Declined' | 'Cancelled'

Status da solicitação de assinatura.

signing_keystring

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

documentstring

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

documentsstring[]

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

emailstring

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

startDatestring

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

endDatestring

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

folderstring

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

Response

200

Example response

{
  "data": [
    {
      "id": 1601469,
      "signing_key": "5BKLud7blQX2m3NFzhSBgca0S8KD7stu",
      "document": "LuJrWJ01duSEWxHsZoaZ1aU3rHf7QYOg",
      "email": "signatario@exemplo.com",
      "message": "Por favor, assine o contrato.",
      "signature_type": "Testemunha",
      "expire_date": "31/12/2026 23:59:59",
      "send_time": "13/10/2026 14:45:43",
      "update_time": "13/10/2026 14:45:43",
      "creted_at": "13/10/2026 14:45:43",
      "status": "Pending",
      "doubleauth": "1"
    }
  ],
  "links": {
    "first": "https://app.plugsign.com.br/api/requests?page=1",
    "last": "https://app.plugsign.com.br/api/requests?page=1",
    "next": "https://app.plugsign.com.br/api/requests?page=1"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "label": "&laquo; Previous"
      }
    ],
    "path": "https://app.plugsign.com.br/api/requests",
    "per_page": 50,
    "to": 2,
    "total": 2
  }
}

Changes

Nov 3, 20263db1513040ea Revision changes
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  the response's property default value 0 was removed for the status
- info
  the response's property default value 0 was removed for the status
- info
  the response's property default value 0 was removed for the status
- info
  the response's property default value 0 was removed for the status
- info
  the response's property default value 0 was removed for the status
- info
  the response's property default value 0 was removed for the status
- info
  the response's property default value 0 was removed for the status
- info
  removed the Active enum value from the /// response property for the response status
- info
  removed the Inactive enum value from the /// response property for the response status
- info
  removed the Suspended enum value from the /// response property for the response status
- info
  removed the admin enum value from the /// response property for the response status
- info
  removed the all enum value from the // response property for the response status
- info
  removed the draw enum value from the // response property for the response status
- info
  removed the staff enum value from the /// response property for the response status
- info
  removed the superadmin enum value from the /// response property for the response status
- info
  removed the text enum value from the // response property for the response status
- info
  removed the upload enum value from the // response property for the response status
- info
  removed the user enum value from the /// response property for the response status

Operation history