v1

latestOpenAPI 3.1.02026-07-24560263.9 KB

Listar Envelopes

Listar e consultar envelopes

get/envelopes

Query parameters

filter[status]string

Informe um status caso deseje filtrar: draft, running, closed, canceled

filter[name]string

Informe o nome completo do envelope a ser consultado

filter[created]string

Informe os intervalos de datas de criação no padrão da especificação

filter[modified]string

Informe os intervalos de datas de atualização no padrão da especificação

filter[deadline_at]string

Informe os intervalos de datas de deadline conforme padrão da especificação (ISO 8601 e separadas por vírgula)

sortstring

Ordene por nome do envelope (name crescente e -name para decrescente)

Headers

Authorizationstring required

Access Token gerado pelo gestor da conta

Content-type'application/vnd.api+json'

Content-type padrão para todas requisições JSON:API

Response

200

Example response

{
  "links": {
    "first": "https://sandbox.clicksign.com/api/v3/envelopes?page%5Bnumber%5D=1&page%5Bsize%5D=20",
    "last": "https://sandbox.clicksign.com/api/v3/envelopes?page%5Bnumber%5D=1&page%5Bsize%5D=20"
  }
}

All 56 operations