Skip to main content
GET
https://api.enviaai.app
/
v1
/
instances
/
{instanceId}
Obter Instância
curl --request GET \
  --url https://api.enviaai.app/v1/instances/{instanceId} \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": {
    "id": "inst_abc123",
    "name": "Vendas WhatsApp",
    "status": "connected",
    "phone": "5511999999999",
    "profileName": "Empresa Vendas",
    "profilePicUrl": "https://pps.whatsapp.net/...",
    "webhookUrl": "https://myapp.com/webhook",
    "settings": {
      "autoRead": false,
      "autoTyping": true
    },
    "createdAt": "2026-01-01T10:00:00.000Z",
    "lastSeenAt": "2026-02-03T12:00:00.000Z"
  }
}

​
Path Parameters

​
instanceId
string
required
ID da instância

​
Response

​
id
string
ID único da instância
​
name
string
Nome da instância
​
status
string
Status: connected, disconnected, connecting
​
phone
string
Número conectado
​
profileName
string
Nome do perfil WhatsApp
​
profilePicUrl
string
URL da foto de perfil
​
settings
object
Configurações da instância
​
createdAt
string
Data de criação

​
Exemplo

const instance = await client.instances.get('inst_abc123');

console.log('Nome:', instance.name);
console.log('Status:', instance.status);
console.log('Telefone:', instance.phone);

{
  "success": true,
  "data": {
    "id": "inst_abc123",
    "name": "Vendas WhatsApp",
    "status": "connected",
    "phone": "5511999999999",
    "profileName": "Empresa Vendas",
    "profilePicUrl": "https://pps.whatsapp.net/...",
    "webhookUrl": "https://myapp.com/webhook",
    "settings": {
      "autoRead": false,
      "autoTyping": true
    },
    "createdAt": "2026-01-01T10:00:00.000Z",
    "lastSeenAt": "2026-02-03T12:00:00.000Z"
  }
}

​
Erros

CódigoDescrição
instance_not_foundInstância não existe