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

Visualizar requisitos

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

📘

Requisição para visualizar requisitos adicionados no Envelope. Essa é uma requisição GET para /envelopes/{{envelopeid}}/requirements. Em Authorizationadicione o access token de sua conta. No body, deverão ser enviados os atributos listados abaixo.

GET /api/v3/envelopes/{{envelopeid}}/requirements 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}}/requirements 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 201 Created
Content-Type: application/vnd.api+json; charset=utf-8
{
    "data": [],
    "meta": {
        "record_count": 0
    },
    "links": {
        "first": "https://3.clicksign.dev/api/v3/envelopes/6bbdda29-5a14-4767-bf22-cd69f6547122/requirements?page%5Bnumber%5D=1&page%5Bsize%5D=20",
        "last": "https://3.clicksign.dev/api/v3/envelopes/6bbdda29-5a14-4767-bf22-cd69f6547122/requirements?page%5Bnumber%5D=1&page%5Bsize%5D=20"
    }
}