v1

latestOpenAPI 3.1.02026-07-24560263.9 KB

Listar Observadores do Envelope

Listar Observadores de um Envelope

get/envelopes/{envelope_id}/signature_watchers

Path parameters

envelope_idstring required

ID do envelope ao qual deseja listar os observadores

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": "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": "dev@example.com",
        "kind": "all_steps",
        "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"
  }
}