Filtrar Envelope por status

📘
Requisição para a filtragem por status de Envelope na Clicksign. Esta é uma requisição GET para /api/v3/envelopes?filter[status]=, sendo necessário adicionar ao final desse endereço o status a ser exibido, conforme exemplo abaixo. As opções são draft, running, closed e canceled. Não é necessário enviar atributos no body dessa requisição. Esta opção de filtragem pode ser combinada com as demais opções listadas na documentação. Para mais informações, acesse o guia do padrão utilizado.

GET /api/v3/envelopes?filter[status]= 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?filter[status]=canceled HTTP/1.1
Host: sandbox.clicksign.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json

Response

HTTP/1.1 200 OK
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,
                "default_message": null,
                "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"
                    }
                }
            }
        },
        {
            "id": "97653e2d-fb6c-461c-9f76-c9060c97f93b",
            "type": "envelopes",
            "links": {
                "self": "https://3.clicksign.dev/api/v3/envelopes/97653e2d-fb6c-461c-9f76-c9060c97f93a"
            },
            "attributes": {
                "name": "novo.docx",
                "status": "canceled",
                "deadline_at": "2023-09-02T10:08:03.486-03:00",
                "locale": "pt-BR",
                "auto_close": false,
                "rubric_enabled": false,
                "remind_interval": 3,
                "block_after_refusal": true,
                "default_message": null,
                "created": "2023-08-03T10:08:03.487-03:00",
                "modified": "2023-08-03T11:47:40.808-03:00"
            },
            "relationships": {
                "documents": {
                    "links": {
                        "self": "https://3.clicksign.dev/api/v3/envelopes/97653e2d-fb6c-461c-9f76-c9060c97f93a/relationships/documents",
                        "related": "https://3.clicksign.dev/api/v3/envelopes/97653e2d-fb6c-461c-9f76-c9060c97f93a/documents"
                    }
                },
                "signers": {
                    "links": {
                        "self": "https://3.clicksign.dev/api/v3/envelopes/97653e2d-fb6c-461c-9f76-c9060c97f93a/relationships/signers",
                        "related": "https://3.clicksign.dev/api/v3/envelopes/97653e2d-fb6c-461c-9f76-c9060c97f93a/signers"
                    }
                },
                "requirements": {
                    "links": {
                        "self": "https://3.clicksign.dev/api/v3/envelopes/97653e2d-fb6c-461c-9f76-c9060c97f93a/relationships/requirements",
                        "related": "https://3.clicksign.dev/api/v3/envelopes/97653e2d-fb6c-461c-9f76-c9060c97f93a/requirements"
                    }
                }
            }
        }
    ],
    "meta": {
        "record_count": 2
    },
    "links": {
        "first": "https://3.clicksign.dev/api/v3/envelopes?filter%5Bstatus%5D=canceled&page%5Bnumber%5D=1&page%5Bsize%5D=20",
        "last": "https://3.clicksign.dev/api/v3/envelopes?filter%5Bstatus%5D=canceled&page%5Bnumber%5D=1&page%5Bsize%5D=20"
    }
}