Skip to main content
GET
Listar envelopes
Lista envelopes com suporte a filtros (estado, CPF de signatário, código externo) e paginação.

Parâmetros de query

enum
Filtrar por estado: CREATED, AWAITING_SIGNATURE, SIGNING_IN_PROGRESS, FINISHED, CANCELLED, EXPIRED, REFUSED.
string
Filtrar por código externo do seu sistema.
string
Filtrar por CPF de um signatário (formato sem dígitos, ex: "12345678901").
integer
Número da página (começa em 1). Padrão: 1.
integer
Itens por página. Padrão: 10. Máximo: 100.

Respostas

array
Lista de envelopes.
integer
Total de envelopes que correspondem ao filtro.
integer
Página atual.
integer
Itens por página.

Erros

Veja Autenticação e erros para detalhes.
  • 400: Parâmetros de query inválidos (ex: state com valor desconhecido).
  • 401: API key/Bearer token inválido.

Exemplo

Relacionado