v1

latestOpenAPI 3.0.02026-07-26626596.3 KB

Conexões

Buscar instancia por ID

get/api/v1/instances/{id}

Path parameters

idstring required

Response

idstring

Identificador único da instância

namestring

Nome da instância

createdAtstring date-time

Data de criação da instância

updatedAtstring date-time

Data de atualização da instância

platformstring

Platforma da instância

providerstring

Provedor da integração

enginestring

Motor da instância

configobject

Configurações adicionais da instância

isActiveboolean

Indica se a instância está ativa

webhookstring

Path do webhook

statusstring

Status da conexão

errorCodestring

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

errorMessagestring

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

deletedAtstring date-time

Data de exclusão da instância

Example response

{
  "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"
}