Skip to main content
GET
/
api
/
v1
/
instances
Buscar instancias
curl --request GET \
  --url https://api.datacrazy.io/v1/api/api/v1/instances \
  --header 'Authorization: Bearer <token>'
{
  "id": "507f1f77bcf86cd799439011",
  "name": "Instância atendimentos suporte",
  "createdAt": "2024-04-11T12:00:00.000Z",
  "updatedAt": "2024-04-11T14:30:00.000Z",
  "platform": "WHATSAPP",
  "provider": "WHATSAPP_CLOUD_API",
  "engine": "WHATSAPP_CLOUD_API_19",
  "config": {
    "endAutomationInterval": 15,
    "endTypingInterval": 1,
    "evolutionApiUrl": "https://evolution-evolution2.mcmoxg.easypanel.host",
    "evolutionInstanceId": "Instancia suporte",
    "evolutionInstanceToken": "78523FD522AA-97KD-8C0F-8138D5A84671",
    "listenGroups": false,
    "typeList": "buttons",
    "startAutomationInterval": 3,
    "startTypingInterval": 0,
    "typingInterval": false
  },
  "isActive": true,
  "webhook": "/webhooks/z-api/d129a692-e5ab-42b3-b0e4-90ad9a12b068/68597f2a95fb0298e5c128b5",
  "status": "CONNECTED",
  "errorCode": "429",
  "errorMessage": "Não foi possível se conectar com o provedor",
  "deletedAt": "2025-11-07T22:05:15.754Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json
​
id
string

Identificador único da instância

Example:

"507f1f77bcf86cd799439011"

​
name
string

Nome da instância

Example:

"Instância atendimentos suporte"

​
createdAt
string<date-time>

Data de criação da instância

Example:

"2024-04-11T12:00:00.000Z"

​
updatedAt
string<date-time>

Data de atualização da instância

Example:

"2024-04-11T14:30:00.000Z"

​
platform
string

Platforma da instância

Example:

"WHATSAPP"

​
provider
string

Provedor da integração

Example:

"WHATSAPP_CLOUD_API"

​
engine
string

Motor da instância

Example:

"WHATSAPP_CLOUD_API_19"

​
config
object

Configurações adicionais da instância

Example:
{
  "endAutomationInterval": 15,
  "endTypingInterval": 1,
  "evolutionApiUrl": "https://evolution-evolution2.mcmoxg.easypanel.host",
  "evolutionInstanceId": "Instancia suporte",
  "evolutionInstanceToken": "78523FD522AA-97KD-8C0F-8138D5A84671",
  "listenGroups": false,
  "typeList": "buttons",
  "startAutomationInterval": 3,
  "startTypingInterval": 0,
  "typingInterval": false
}
​
isActive
boolean

Indica se a instância está ativa

Example:

true

​
webhook
string

Path do webhook

Example:

"/webhooks/z-api/d129a692-e5ab-42b3-b0e4-90ad9a12b068/68597f2a95fb0298e5c128b5"

​
status
string

Status da conexão

Example:

"CONNECTED"

​
errorCode
string

Código de erro da conexão com a instância

Example:

"429"

​
errorMessage
string

Mensagem de erro da conexão com a instância

Example:

"Não foi possível se conectar com o provedor"

​
deletedAt
string<date-time>

Data de exclusão da instância

Example:

"2025-11-07T22:05:15.754Z"