Listar conversas

Busca a lista paginada de conversas do workspace.

GEThttps://external-api.lip7.com.br/api/external/conversations

Escopoconversations:readSíncrono — responde 200 com os dados

Operação de leitura — não altera nada. Os resultados são sempre limitados ao workspace dono da API key.

Query params

pagenumberopcionalpadrão 1

Número da página.

limitnumberopcionalpadrão 20

Itens por página, com máximo de 100.

statusstringopcional

Filtra pelo status da conversa.

valoresBOTHUMANCLOSEDQUEUED

prioritystringopcional

Filtra pela prioridade.

valoreslowmediumhigh

tagsstringopcional

Lista separada por vírgula, por exemplo vip,suporte.

chatTypestringopcional

Tipo do chat.

valoresINDIVIDUALGROUP

searchstringopcional

Busca por termo — nome, telefone ou conteúdo.

assignedWorkspaceMemberstringopcional

ID do membro responsável pela conversa.

Regras de seleção

Com search, a busca textual é aplicada junto com os demais filtros.
Sem search, mas com status, lista as conversas naquele status.
Sem search e sem status, lista as conversas ativas.

Valores de referência

Campo	Valores possíveis
`status` da conversa	`BOT`, `HUMAN`, `CLOSED`, `QUEUED`
`chatType`	`INDIVIDUAL`, `GROUP`
`priority`	`low`, `medium`, `high`

Esta listagem usa o formato de chave nomeada — veja Paginação.

Requisição

curl -X GET "https://external-api.lip7.com.br/api/external/conversations?status=HUMAN&limit=20" \
  -H "x-api-key: lip_SUA_CHAVE"

const response = await fetch(
  'https://external-api.lip7.com.br/api/external/conversations?status=HUMAN&limit=20',
  { headers: { 'x-api-key': 'lip_SUA_CHAVE' } }
);

const data = await response.json();

import requests

response = requests.get(
    "https://external-api.lip7.com.br/api/external/conversations",
    headers={"x-api-key": "lip_SUA_CHAVE"},
    params={"status": "HUMAN", "limit": 20},
)

data = response.json()

Resposta

{
  "success": true,
  "data": {
    "conversations": [
      {
        "id": "conv_...",
        "phoneNumber": "5511999999999",
        "displayName": "Maria",
        "channel": "whatsapp",
        "status": "HUMAN",
        "chatType": "INDIVIDUAL",
        "groupSubject": null,
        "priority": "medium",
        "tags": ["vip"],
        "contactId": "contact_...",
        "assignedWorkspaceMemberId": "member_...",
        "isActive": true,
        "totalUnreadCount": 2,
        "lastMessageAt": "2026-06-15T18:00:00.000Z",
        "createdAt": "2026-06-10T12:00:00.000Z",
        "updatedAt": "2026-06-15T18:00:00.000Z"
      }
    ],
    "total": 1,
    "page": 1,
    "totalPages": 1
  }
}