Listar Documentos

Retorna a lista paginada de envelopes da conta, com opcoes de filtro por status e busca textual.

Requisicao

GET /v1/envelopes

Headers

Header	Tipo	Obrigatorio	Descricao
Authorization	string	Sim	Bearer token de autenticacao

Parametros de Query

Parametro	Tipo	Obrigatorio	Padrao	Descricao
page	number	Nao	0	Numero da pagina (comeca em 0)
size	number	Nao	20	Quantidade de itens por pagina (max 100)
status	string	Nao	—	Filtrar por status: DRAFT, SENT, IN_PROGRESS, COMPLETED, CANCELED, EXPIRED
search	string	Nao	—	Busca textual por nome do envelope ou signatario

Exemplo de requisicao

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": "env_d4e5f6a7-8b9c-0d1e-2f3a-4b5c6d7e8f9a",
      "name": "Contrato de Prestacao de Servicos - Carlos Mendes",
      "status": "IN_PROGRESS",
      "signersCount": 3,
      "signedCount": 1,
      "createdAt": "2026-03-25T10:15:30Z",
      "updatedAt": "2026-03-26T15:42:00Z",
      "expiresAt": "2026-04-24T10:15:30Z"
    },
    {
      "id": "env_a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
      "name": "Contrato de Locacao - Apartamento 302",
      "status": "IN_PROGRESS",
      "signersCount": 2,
      "signedCount": 1,
      "createdAt": "2026-03-20T08:00:00Z",
      "updatedAt": "2026-03-22T11:30:00Z",
      "expiresAt": "2026-04-19T08:00:00Z"
    }
  ],
  "page": 0,
  "size": 10,
  "totalElements": 2,
  "totalPages": 1
}

Campos da resposta

Campo	Tipo	Descricao
content	array	Lista de envelopes
content[].id	string	Identificador unico do envelope
content[].name	string	Nome do envelope
content[].status	string	Status atual do envelope
content[].signersCount	number	Total de signatarios
content[].signedCount	number	Quantidade de signatarios que ja assinaram
content[].createdAt	string	Data de criacao (ISO 8601)
content[].updatedAt	string	Data da ultima atualizacao (ISO 8601)
content[].expiresAt	string	Data de expiracao (ISO 8601)
page	number	Pagina atual
size	number	Tamanho da pagina
totalElements	number	Total de envelopes encontrados
totalPages	number	Total de paginas disponiveis

Dica

Combine os parametros status e search para encontrar documentos especificos rapidamente. Por exemplo, buscar por status=COMPLETED&search=locacao retorna apenas contratos de locacao finalizados.

401 - Nao autorizado

{
  "error": "UNAUTHORIZED",
  "message": "Token de autenticacao invalido ou expirado."
}

Paginacao

O tamanho maximo por pagina e de 100 itens. Para listas grandes, utilize a paginacao incrementando o parametro page.