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

Listar Observadores de Assinatura

GET /api/v3/envelopes/{envelope_id}/signature_watchers

👍

Observadores de Assinatura

Com esta funcionalidade, você poderá listar os detalhes dos observadores que acompanham o processo de assinatura.

📘

Requisição para a listar todos os Observador de Assinatura na Clicksign. Esta é uma requisição GET para /api/v3/envelopes/{envelope_id}/signature_watchers.

GET /api/v3/envelopes/{envelope_id}/signature_watchers 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/{envelope_id}/signature_watchers 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: application/vnd.api+json; charset=utf-8
{
  "data": [
    {
      "id": "ca839f4a-e567-4017-ba38-c96115068cae",
      "type": "signature_watchers",
      "links": {
        "self": "https://sandbox.clicksign.com/api/v3/envelopes/a4ecaa4a-1453-4e63-95cf-988422f7003f/signature_watchers/ca839f4a-e567-4017-ba38-c96115068cae"
      },
      "attributes": {
        "email": "[email protected]",
        "kind": "all_steps",
        "attach_documents_enabled": true,
        "communicate_events": {
          "signature_watcher_document_sent": "email",
          "signature_watcher_document_signed": "email",
          "signature_watcher_document_deadline": "email",
          "signature_watcher_document_canceled": "email",
          "signature_watcher_envelope_closed": "email"
        },
        "created": "2024-05-08T15:32:21.651-03:00",
        "modified": "2024-05-08T15:32:21.651-03:00"
      }
    }
  ],
  "meta": {
    "record_count": 1
  },
  "links": {
    "first": "https://sandbox.clicksign.com/api/v3/signature_watchers?page%5Bnumber%5D=1&page%5Bsize%5D=20",
    "last": "https://sandbox.clicksign.com/api/v3/signature_watchers?page%5Bnumber%5D=1&page%5Bsize%5D=20"
  }
}