v1

latestOpenAPI 3.1.02026-07-24560263.9 KB

Eventos de um Documento

Listar eventos de um Documento do Envelope

get/envelopes/{envelope_id}/documents/{document_id}/events

Path parameters

envelope_idstring required

ID do envelope ao qual o documento pertence para consultar eventos

document_idstring required

ID do Documento que deseja listar os eventos

Query parameters

filter[name]string

Parametro utilizado para filtrar eventos por nome. Informe um dos status listados aqui https://developers.clicksign.com/docs/eventos

Headers

Authorizationstring

Access Token gerado pelo gestor da conta

Content-type'application/vnd.api+json'

Content-type padrão para todas requisições JSON:API

Response

200

Example response

{
  "data": [
    {
      "id": "9f1fefdb-bb5c-4c84-9419-baecf6aff610",
      "type": "events",
      "attributes": {
        "name": "upload",
        "data": {
          "user": {
            "email": "example@example.com",
            "name": "Signer Name"
          },
          "account": {
            "key": "c710d54e-38df-4945-b750-2887da0a6aa2"
          },
          "deadline_at": "2024-04-18T15:18:52.599-03:00",
          "auto_close": true,
          "locale": "pt-BR"
        },
        "created": "2024-03-18T15:18:52.743-03:00"
      }
    }
  ],
  "meta": {
    "record_count": 1
  },
  "links": {
    "first": "https://sandbox.clicksign.dev/api/v3/events?page%5Bnumber%5D=1&page%5Bsize%5D=20",
    "last": "https://sandbox.clicksign.dev/api/v3/events?page%5Bnumber%5D=1&page%5Bsize%5D=20"
  }
}