Listar Modelos

Retorna a lista paginada dos modelos do usuário autenticado, do mais recente para o mais antigo. É o ponto de partida para descobrir o id (o templateId) e as variáveis de cada modelo.

Endpoint

GET /v1/models

Headers

Header	Valor
Authorization	Bearer {token}

Query Parameters

Parâmetro	Tipo	Obrigatório	Descrição
page	number	Não	Página, começando em 0. Padrão: 0
size	number	Não	Itens por página. Padrão: 10
search	string	Não	Filtra pelo nome do modelo (contém o texto, sem diferenciar maiúsculas e minúsculas)
folderId	string (UUID)	Não	Filtra por pasta. É ignorado quando search também é enviado
filterByOrg	boolean	Não	Liga o filtro por organização. Padrão: false
organizationId	number	Não	Com filterByOrg=true, traz os modelos dessa organização. Sem organizationId, traz só os modelos pessoais

Quais modelos aparecem

A lista traz apenas os modelos criados pelo usuário dono do token. Modelos de uma organização criados por outros membros não aparecem.

Exemplo de Requisição

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

Resposta de Sucesso

Status: 200 OK

Exemplo resumido. Cada item de content tem o formato descrito em Detalhar Modelo.

{
  "content": [
    {
      "id": "3f6b2c1e-8d4a-4f7b-9c2e-5a1d0b7e9f10",
      "name": "Contrato de Prestação de Serviços",
      "type": "DOCX",
      "status": "ACTIVE",
      "folderId": null,
      "organizationId": null,
      "fields": [
        { "name": "nome_completo", "fieldType": "TEXT", "required": true },
        { "name": "cpf", "fieldType": "TEXT", "required": true }
      ],
      "signers": [],
      "documentsCount": 127,
      "createdAt": "2026-09-01T10:00:00Z",
      "updatedAt": "2026-09-12T14:30:00Z"
    }
  ],
  "totalElements": 1,
  "totalPages": 1,
  "size": 10,
  "number": 0
}

Campos da Resposta

Campo	Tipo	Descrição
content	array	Modelos da página atual
totalElements	number	Total de modelos encontrados
totalPages	number	Total de páginas
size	number	Itens por página
number	number	Página atual (começa em 0)

Erros

Código	Quando acontece
400	Parâmetro com tipo inválido, por exemplo folderId que não é UUID
401	Token ausente ou inválido

Dica

A rota não filtra por status. Para gerar documentos, use só modelos com status igual a ACTIVE: modelo inativo é recusado na criação de documentos.