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

Listar eventos por Envelope

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

📘

Requisição para listar eventos por Envelope na Clicksign. Esta é uma requisição GET para /api/v3/envelopes/{{envelopeid}}/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}}/events HTTP/1.1
Host: sandbox.clicksign.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Authorization: access token
❗️

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}}/events HTTP/1.1
Host: sandbox.clicksign.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Authorization: access token

Response

HTTP/1.1 200 OK
Content-Type: vnd.api+json; charset=utf-8
{
    "data": [
        {
            "id": "28c01364-732e-4120-b4d8-65a5bfcdea4d",
            "type": "events",
            "attributes": {
                "name": "upload",
                "data": {
                    "user": {
                        "email": "[email protected]",
                        "name": "Silva Silva"
                    },
                    "account": {
                        "key": "10187809-d260-4b98-8820-037cc9ab8f6d"
                    },
                    "deadline_at": "2023-11-03T16:51:35.861-03:00",
                    "auto_close": true,
                    "locale": "pt-BR"
                },
                "created": "2023-10-04T16:51:36.126-03:00"
            }
        }
    ],
    "meta": {
        "record_count": 1
    },
    "links": {
        "first": "https://sandbox.clicksign.com/api/v3/events?page%5Bnumber%5D=1&page%5Bsize%5D=20",
        "last": "https://sandbox.clicksign.com/api/v3/events?page%5Bnumber%5D=1&page%5Bsize%5D=20"
    }
}