v1

latestOpenAPI 3.1.02026-08-041060342.7 KB

GET All requests

Através deste endpoint, você pode obter os dados das solicitações já enviadas para assinatura.

get/api/requests

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[]

Array contendo Documents Keys dos documentos, para obter todas as solicitações relacionadas a eles.

emailstring

Endereço de e-mail do signatário, para obter todos os envios para uma pessoa específica.

startDatestring

Data válida no formato d-m-Y, e deve ser posterior ou igual a endDate.

endDatestring

Data válida no formato d-m-Y, e deve ser inferior ou igual a startDate.

folderstring

Nome ou Id da pasta em que o documento do request está presente.

Response

200

Example response

{
  "data": [
    {
      "id": 1601469,
      "signing_key": "5BKLud7blQX2m3NFzhSBgca0S8KD7stu",
      "document": "LuJrWJ01duSEWxHsZoaZ1aU3rHf7QYOg",
      "email": "exemplo@gmail.com",
      "message": "teste",
      "positions": "[\"1041.33\",{\"type\":\"image\",\"page\":\"1\",\"xPos\":\"-999\",\"yPos\":\"-999\",\"width\":\"200\",\"height\":\"75\",\"fontsize\":null,\"group\":\"input\"}]",
      "signature_type": "all",
      "doubleauth": "0",
      "sender": {
        "id": 122,
        "name": "Teste",
        "last_name": "Costa",
        "email": "teste@hotmail.com",
        "phone": "989939999",
        "permissions": [
          "edit"
        ],
        "recive_email": 1,
        "role": "admin",
        "status": "Active",
        "certificate": {
          "certificate_name": "MINHA EMPRESA",
          "issuer": "ICP-Brasil",
          "model": "Certificado PJ",
          "validity": "2025-10-04 11:21:00"
        }
      },
      "send_time": "27/05/2025 01:39:24",
      "update_time": "04/06/2025 21:17:57",
      "creted_at": "27/05/2025 01:39:24",
      "status": "Pending"
    }
  ],
  "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": 15,
    "to": 1,
    "total": 1
  }
}