Skip to main content
GET
List conversations

Autorizações

X-Api-Key
string
header
obrigatório

Parâmetros de consulta

page
integer<int32>
padrão:1

1-based page index

limit
integer<int32>
padrão:20

Page size (max 100)

agentPublicId
string<uuid>

Filter by agent public ID

externalUserId
string

Filter by end-user identifier

channel
string

Filter by channel type (api|web_chat|whatsapp|z_api)

isTest
boolean

Filter by test flag (omit for both)

isEnded
boolean

Filter by ended status

since
string<date-time>

Only conversations with lastMessageAt >= since (ISO-8601)

until
string<date-time>

Only conversations with lastMessageAt <= until (ISO-8601)

Resposta

OK

items
object[]
limit
integer<int32>
page
integer<int32>
total
integer<int64>
totalPages
integer<int32>