Skip to main content
GET
Listar conversas

Authorizations

Authorization
string
header
required

Chave de API da Arara (ara_live_...), enviada no header Authorization: Bearer ara_live_.... Crie e gerencie as chaves no painel: https://app.ararahq.com/dashboard/apikeys. O valor completo aparece uma única vez, na criação.

Headers

X-Waba-Id
string<uuid>

Restringe o resultado a uma conta WhatsApp Business (WABA) da organização.

Query Parameters

status
enum<string>

Filtra por status da conversa.

Available options:
OPEN,
CLOSED,
ARCHIVED
leadStatus
string

Filtra pela qualificação do contato.

window
enum<string>

OPEN só conversas respondíveis; EXPIRED só as que exigem template.

Available options:
OPEN,
EXPIRED
page
integer
default:0
Required range: x >= 0
size
integer
default:20
Required range: x >= 1

Response

Página de conversas

content
object[]
required
page
integer
required
size
integer
required
totalElements
integer<int64>
required
totalPages
integer
required