Filtrar Envelope por nome

📘
Requisição para a filtragem por nome de Envelope na Clicksign. Esta é uma requisição GET para /api/v3/envelopes?filter[name]=, sendo necessário adicionar ao final desse endereço o termo a ser pesquisado, conforme exemplo abaixo. 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[name]= 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[name]=Teste 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": [],
    "meta": {
        "record_count": 0
    },
    "links": {
        "first": "https://sandbox.clicksign.com/api/v3/envelopes?filter%5Bname%5D=Teste&page%5Bnumber%5D=1&page%5Bsize%5D=20",
        "last": "https://sandbox.clicksign.com/api/v3/envelopes?filter%5Bname%5D=Teste&page%5Bnumber%5D=1&page%5Bsize%5D=20"
    }
}