These docs are for v2.0. Click to read the latest docs for v3.2.

Listar eventos por documento

GET /api/v3/envelopes/{{envelopeid}}/documents/{{documentid}}/events

📘

Requisição para listar eventos por documento na Clicksign. Esta é uma requisição GET para /api/v3/envelopes/{{envelopeid}}/documents/{{documentid}}/events. Em Authorization adicione o access token de sua conta. Não é necessário enviar atributos no body dessa requisição.

GET api/v3/envelopes/{{envelopeid}}/documents/{{documentid}}/events HTTP/1.1
Host: sandbox.clicksign.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
❗️

Se a requisição para a Clicksign falhar

Sempre verifique o BODY da resposta. O retorno da requisição mostrará o motivo pelo qual a requisição não foi aceita pelos servidores da Clicksign. Confira mais detalhes em Mensagens de erro.

Exemplo completo

Request

GET api/v3/envelopes/{{envelopeid}}/documents/{{documentid}}/events HTTP/1.1
Host: sandbox.clicksign.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json

Response

HTTP/1.1 200 OK
Content-Type: vnd.api+json; charset=utf-8
{
  "data": [{
    "id": "aec47f90-b085-4f3c-ae70-41d477e4c1e5",
    "type": "events",
    "attributes": {
      "name": "upload",
      "data": {
        "user": {
        "email": "[email protected]",
        "name": "Silva Silva"
      },
      "account": {
        "key": "10187809-d260-4b98-8820-037cc9ab8f6d"
      },
      "deadline_at": "2023-11-03T17:25:56.372-03:00",
      "auto_close": true,
      "locale": "pt-BR"
    },
    "created": "2023-10-04T17:25:56.560-03:00"
  }}],
  "meta": {
    "record_count": 1
  },
  "links": {
    "first": "https://3.clicksign.dev/api/v3/events?page%5Bnumber%5D=1&page%5Bsize%5D=20",
    "last": "https://3.clicksign.dev/api/v3/events?page%5Bnumber%5D=1&page%5Bsize%5D=20"
  }
}