curl "https://crm.vistum.com.br/api/v1/conversations?status=open&limit=25" \
-H "Authorization: Bearer vg_live_SUA_CHAVE_AQUI"
{
"data": [
{
"id": "conv_1",
"contact": { "id": "cnt_cmnl5abc123", "name": "João Ferreira", "phone": "5511999887766" },
"instanceId": "inst_a1",
"channel": "whatsapp",
"status": "open",
"lastMessageAt": "2026-07-21T17:50:00.000Z",
"createdAt": "2026-07-20T09:00:00.000Z"
}
],
"pagination": { "total": 1, "limit": 25, "offset": 0, "hasMore": false }
}
Conversas e Mensagens
Listar conversas
Lista as conversas de atendimento do workspace com filtros por instância, status e contato.
GET
/
api
/
v1
/
conversations
curl "https://crm.vistum.com.br/api/v1/conversations?status=open&limit=25" \
-H "Authorization: Bearer vg_live_SUA_CHAVE_AQUI"
{
"data": [
{
"id": "conv_1",
"contact": { "id": "cnt_cmnl5abc123", "name": "João Ferreira", "phone": "5511999887766" },
"instanceId": "inst_a1",
"channel": "whatsapp",
"status": "open",
"lastMessageAt": "2026-07-21T17:50:00.000Z",
"createdAt": "2026-07-20T09:00:00.000Z"
}
],
"pagination": { "total": 1, "limit": 25, "offset": 0, "hasMore": false }
}
Uma conversa representa o fio de atendimento com um contato em uma instância (WhatsApp ou Instagram).
Grupos de WhatsApp e conexões arquivadas nunca aparecem.
Autenticação
string
required
Bearer vg_live_<sua_chave> — API Key com escopo conversations:readParâmetros de query
| Parâmetro | Tipo | Descrição |
|---|---|---|
instanceId | string | Filtra por instância. |
status | string | open, waiting, snoozed ou closed. |
contactId | string | Conversas de um contato específico. Contato de outro tenant → lista vazia. |
limit / offset | number | Paginação (1–100, padrão 25). |
curl "https://crm.vistum.com.br/api/v1/conversations?status=open&limit=25" \
-H "Authorization: Bearer vg_live_SUA_CHAVE_AQUI"
{
"data": [
{
"id": "conv_1",
"contact": { "id": "cnt_cmnl5abc123", "name": "João Ferreira", "phone": "5511999887766" },
"instanceId": "inst_a1",
"channel": "whatsapp",
"status": "open",
"lastMessageAt": "2026-07-21T17:50:00.000Z",
"createdAt": "2026-07-20T09:00:00.000Z"
}
],
"pagination": { "total": 1, "limit": 25, "offset": 0, "hasMore": false }
}