Listar Modelos

Retorna uma lista paginada de todos os modelos da conta, com opcoes de filtro por status e busca por nome.

Endpoint

GET /v1/models

Headers

Header	Valor
Authorization	Bearer {token}

Query Parameters

Parametro	Tipo	Obrigatorio	Descricao
page	number	Nao	Numero da pagina (padrao: 1)
size	number	Nao	Itens por pagina (padrao: 20, maximo: 100)
search	string	Nao	Busca por nome do modelo
status	string	Nao	Filtrar por status: ACTIVE ou INACTIVE

Exemplo de Requisicao

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

Resposta de Sucesso

Status: 200 OK

{
  "data": [
    {
      "id": "m1o2d3e4-l5o6-7890-abcd-ef1234567890",
      "name": "Contrato de Prestacao de Servicos",
      "status": "ACTIVE",
      "fieldsCount": 4,
      "documentCount": 127,
      "createdAt": "2026-03-15T10:00:00Z",
      "updatedAt": "2026-03-29T14:30:00Z"
    },
    {
      "id": "n2p3q4r5-s6t7-8901-bcde-f12345678901",
      "name": "Contrato de Locacao",
      "status": "ACTIVE",
      "fieldsCount": 8,
      "documentCount": 45,
      "createdAt": "2026-03-10T08:00:00Z",
      "updatedAt": "2026-03-28T16:00:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "size": 20,
    "total": 2,
    "totalPages": 1
  }
}

Campos da Resposta

Array data

Campo	Tipo	Descricao
id	string (UUID)	ID unico do modelo
name	string	Nome do modelo
status	string	Status: ACTIVE ou INACTIVE
fieldsCount	number	Quantidade de variaveis no modelo
documentCount	number	Quantidade de documentos gerados a partir deste modelo
createdAt	string (ISO 8601)	Data de criacao
updatedAt	string (ISO 8601)	Data da ultima atualizacao

Objeto pagination

Campo	Tipo	Descricao
page	number	Pagina atual
size	number	Itens por pagina
total	number	Total de registros
totalPages	number	Total de paginas

Erros

Codigo	Descricao
400	Parametros de query invalidos
401	Token de autenticacao invalido

Dica

Use o parametro search para encontrar modelos rapidamente. A busca e feita por correspondencia parcial no nome do modelo (case-insensitive).