Skip to main content
GET
/
api
/
user-databases
curl -X GET https://api.disparador.com/api/user-databases \\
  -H "X-Access-Token: seu-access-token"

[
  {
    "id": 42,
    "name": "Clientes Ativos",
    "description": "Renovações 2025",
    "origin": "UPLOAD",
    "status": "ACTIVE",
    "rowCount": 1345,
    "columns": [
      { "columnName": "phone", "displayName": "Telefone", "dataType": "text", "isPhoneColumn": true }
    ],
    "createdAt": "2025-01-12T15:22:00Z",
    "updatedAt": "2025-02-01T10:00:00Z"
  }
]
Esses endpoints exigem um X-Access-Token válido. Apenas bancos pertencentes à mesma empresa do token são retornados.

​
Headers

​
Content-Type
string
application/json
​
X-Access-Token
string
required
Token obtido no login

​
Listar todos os bancos

GET /api/user-databases Retorna todos os bancos customizados e do sistema visíveis para a empresa.
​
id
number
ID interno do banco
​
name
string
Nome legível configurado pelo usuário
​
description
string
Descrição opcional exibida no painel
​
status
string
ACTIVE, INACTIVE, PROCESSING ou ERROR
​
origin
string
UPLOAD, EVOLUTION, PUSH_IMPORT ou SYSTEM
​
rowCount
number
Total de registros persistidos
​
columns
array
Metadados com columnName, displayName, dataType, flags de telefone/nome e posição
​
evolution*
mixed
Campos exclusivos de sincronizações Evolution (configId, includeGroups, lastSyncSummary, etc.)
curl -X GET https://api.disparador.com/api/user-databases \\
  -H "X-Access-Token: seu-access-token"

[
  {
    "id": 42,
    "name": "Clientes Ativos",
    "description": "Renovações 2025",
    "origin": "UPLOAD",
    "status": "ACTIVE",
    "rowCount": 1345,
    "columns": [
      { "columnName": "phone", "displayName": "Telefone", "dataType": "text", "isPhoneColumn": true }
    ],
    "createdAt": "2025-01-12T15:22:00Z",
    "updatedAt": "2025-02-01T10:00:00Z"
  }
]

​
Buscar um banco específico

GET /api/user-databases/{id} Mesma estrutura do endpoint de listagem, retornando apenas o banco solicitado. 
curl -X GET https://api.disparador.com/api/user-databases/42 \\
  -H "X-Access-Token: seu-access-token"

​
Contagem e limites

GET /api/user-databases/count Retorna estatísticas usadas na UI:
​
userDatabases
number
Quantos bancos customizados pertencem à empresa
​
systemDatabases
number
Bancos provisionados pelo sistema e compartilhados
​
totalDatabases
number
Soma total
​
limit
number
Limite contratado para criação de bancos
​
remaining
number
Quantos bancos ainda podem ser criados antes de atingir o limite

​
Status e exclusão

  • PATCH /api/user-databases/{id}/toggle-status alterna entre ACTIVE e INACTIVE.
  • DELETE /api/user-databases/{id} remove definitivamente o banco e todos os registros.
Não existe lixeira para bancos removidos. Faça backup antes de deletar.