Visualizar Envelope

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

📘
Requisição para visualizar dados de Envelope já criado na Clicksign. Essa é uma requisição GET para /envelopes/{{envelopeid}}. Em Authorizationadicione o access token de sua conta. Não é necessário enviar atributos no body dessa requisição.

GET /api/v3/envelopes/{{envelopeid}} 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/envelope{{envelopeid}} 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": {
        "id": "48abb7f2-66d4-45e0-8d31-4a2c62b78112",
        "type": "envelopes",
        "links": {
            "self": "https://3.clicksign.dev/api/v3/envelopes/48abb7f2-66d4-45e0-8d31-4a2c62b78112"
        },
        "attributes": {
            "name": "Novo teste",
            "status": "canceled",
            "deadline_at": "2023-11-01T18:02:12.933-03:00",
            "locale": "pt-BR",
            "auto_close": true,
            "remind_interval": 7,
            "block_after_refusal": true,
            "created": "2023-08-03T12:21:22.107-03:00",
            "modified": "2023-08-03T12:36:21.146-03:00"
        },
        "relationships": {
            "documents": {
                "links": {
                    "self": "https://3.clicksign.dev/api/v3/envelopes/48abb7f2-66d4-45e0-8d31-4a2c62b78112/relationships/documents",
                    "related": "https://3.clicksign.dev/api/v3/envelopes/48abb7f2-66d4-45e0-8d31-4a2c62b78112/documents"
                }
            },
            "signers": {
                "links": {
                    "self": "https://3.clicksign.dev/api/v3/envelopes/48abb7f2-66d4-45e0-8d31-4a2c62b78112/relationships/signers",
                    "related": "https://3.clicksign.dev/api/v3/envelopes/48abb7f2-66d4-45e0-8d31-4a2c62b78112/signers"
                }
            },
            "requirements": {
                "links": {
                    "self": "https://3.clicksign.dev/api/v3/envelopes/48abb7f2-66d4-45e0-8d31-4a2c62b78112/relationships/requirements",
                    "related": "https://3.clicksign.dev/api/v3/envelopes/48abb7f2-66d4-45e0-8d31-4a2c62b78112/requirements"
                }
            }
        }
    }
}