Listar Documentos

Retorna a lista paginada dos envelopes da conta autenticada, do mais recente para o mais antigo, com filtros por status, busca textual, período e organização.

Requisição

GET /v1/envelopes

Headers

Header	Tipo	Obrigatório	Descrição
Authorization	string	Sim	Bearer {token}

Parâmetros de Query

Parâmetro	Tipo	Obrigatório	Padrão	Descrição
page	number	Não	0	Número da página (começa em 0)
size	number	Não	20	Quantidade de itens por página
status	string	Não	-	DRAFT, SENT, IN_PROGRESS, COMPLETED, CANCELED ou EXPIRED
search	string	Não	-	Busca no título do envelope, no nome ou e-mail de signatários e no ID do envelope. Não diferencia maiúsculas de minúsculas
dateFrom	string	Não	-	Data inicial de criação, no formato yyyy-MM-dd
dateTo	string	Não	-	Data final de criação, no formato yyyy-MM-dd (inclui o dia inteiro)
filterByOrg	boolean	Não	false	Ativa o filtro por organização (veja abaixo)
organizationId	number	Não	-	Organização usada quando filterByOrg=true

Filtro por organização

• filterByOrg=false (padrão): todos os seus envelopes, pessoais e de organizações.
• filterByOrg=true sem organizationId: só os envelopes pessoais, sem organização.
• filterByOrg=true com organizationId: só os envelopes dessa organização.

Em todos os casos, a lista traz apenas envelopes cujo dono é a conta autenticada.

Datas

dateFrom e dateTo filtram pela data de criação do envelope e consideram o dia no horário de Brasília.

Envelopes na lixeira não aparecem nesta lista. Para vê-los, use GET /v1/envelopes/trash (veja Excluir Documento).

Exemplo de requisição

curl -X GET \
  "https://api.tapsign.com.br/v1/envelopes?page=0&size=10&status=IN_PROGRESS&search=contrato" \
  -H "Authorization: Bearer {token}"

Resposta

200 - Sucesso

{
  "content": [
    {
      "id": 512,
      "ownerId": 57,
      "documentId": 1024,
      "organizationId": null,
      "title": "Contrato de Prestação de Serviços",
      "message": "Por favor, revise e assine.",
      "status": "IN_PROGRESS",
      "expiresAt": "2026-10-12T14:35:00Z",
      "signOrder": "PARALLEL",
      "createdAt": "2026-09-12T14:31:00Z",
      "updatedAt": "2026-09-12T15:40:12Z",
      "sentAt": "2026-09-12T14:35:00Z",
      "completedAt": null,
      "createdByEmail": "[email protected]",
      "folderId": null
    }
  ],
  "totalElements": 1,
  "totalPages": 1,
  "size": 10,
  "number": 0
}

A resposta segue o formato de página do Spring e também traz outros campos de paginação, como first, last e numberOfElements.

Campos da resposta

Campo	Tipo	Descrição
content	array	Envelopes da página. Cada item tem os mesmos campos da resposta de criar envelope
totalElements	number	Total de envelopes encontrados
totalPages	number	Total de páginas
size	number	Tamanho da página
number	number	Página atual (começa em 0)

Dica

Combine status e search para achar documentos específicos. Por exemplo, status=COMPLETED&search=locacao retorna os envelopes concluídos com "locacao" no título ou nos dados de algum signatário.

Evite consultar status em loop

Para saber quando um documento foi assinado, configure webhooks em vez de listar envelopes repetidamente.

Erros

Código	Quando acontece
400	status fora da lista, ou data fora do formato yyyy-MM-dd
401	Token ausente ou inválido