Filtrar Envelope por data de criação

📘
Requisição para a filtragem por data de criação de Envelope na Clicksign. Esta é uma requisição GET para /api/v3/envelopes?filter[created]=, sendo necessário adicionar ao final desse endereço a data a ser exibida (data ou datetime no formato ISO 8601) para um resultado específico. O envio sem a data retornará a listagem de todos os envelopes. 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[created]= HTTP/1.1
Host: sandbox.clicksign.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json

❗️
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[created]=2023-08-07T00:41:43.690-03:00,2023-08-07T23:41:43.690-03:00 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": [
    {
      "id": "5a5be9f8-2391-425f-84a7-bde98205dede",
      "type": "envelopes",
      "links": {
        "self": "https://3.clicksign.dev/api/v3/envelopes/5a5be9f8-2391-425f-84a7-bde98205dede"
      },
      "attributes": {
        "name": "Envelope_teste",
        "status": "draft",
        "deadline_at": "2023-11-01T18:02:12.933-03:00",
        "locale": "pt-BR",
        "auto_close": true,
        "remind_interval": 3,
        "block_after_refusal": true,
        "default_message": null,
        "created": "2023-08-07T11:41:43.690-03:00",
        "modified": "2023-08-07T11:41:43.698-03:00"
      },
      "relationships": {
        "documents": {
          "links": {
            "self": "https://3.clicksign.dev/api/v3/envelopes/5a5be9f8-2391-425f-84a7-bde98205dede/relationships/documents",
            "related": "https://3.clicksign.dev/api/v3/envelopes/5a5be9f8-2391-425f-84a7-bde98205dede/documents"
          }
        },
        "signers": {
          "links": {
            "self": "https://3.clicksign.dev/api/v3/envelopes/5a5be9f8-2391-425f-84a7-bde98205dede/relationships/signers",
            "related": "https://3.clicksign.dev/api/v3/envelopes/5a5be9f8-2391-425f-84a7-bde98205dede/signers"
          }
        },
        "requirements": {
          "links": {
            "self": "https://3.clicksign.dev/api/v3/envelopes/5a5be9f8-2391-425f-84a7-bde98205dede/relationships/requirements",
            "related": "https://3.clicksign.dev/api/v3/envelopes/5a5be9f8-2391-425f-84a7-bde98205dede/requirements"
          }
        }
      }
    }
  ],
  "meta": {
    "record_count": 1
  },
  "links": {
    "first": "https://3.clicksign.dev/api/v3/envelopes?filter%5Bcreated%5D=2023-08-07T00%3A41%3A43.690-03%3A00%2C2023-08-07T23%3A41%3A43.690-03%3A00&page%5Bnumber%5D=1&page%5Bsize%5D=20",
    "last": "https://3.clicksign.dev/api/v3/envelopes?filter%5Bcreated%5D=2023-08-07T00%3A41%3A43.690-03%3A00%2C2023-08-07T23%3A41%3A43.690-03%3A00&page%5Bnumber%5D=1&page%5Bsize%5D=20"
  }
}