Skip to main content
GET
Listar conversas

Autorizações

Authorization
string
header
obrigatório

Token da API no formato sk_live_….

Parâmetros de consulta

page
integer
padrão:1

Número da página, começando em 1. Um valor inválido é tratado como 1.

Intervalo obrigatório: x >= 1
perPage
integer
padrão:20

Quantidade de itens por página. O máximo depende do ambiente (padrão 100).

Intervalo obrigatório: 1 <= x <= 100
status
string

Filtra pela situação do atendimento. Aceita vários valores separados por vírgula (ex.: open,pending).

Exemplo:

"open,pending"

queueId
integer

Somente atendimentos desta fila.

userId
integer

Somente atendimentos deste atendente responsável.

channelId
integer
contactId
integer
tagId
integer

Somente atendimentos com esta tag.

from
string<date>

Início do período, no fuso horário da empresa.

to
string<date>

Fim do período, no fuso horário da empresa.

dateField
enum<string>
padrão:created

Define qual data o filtro de período usa: a de criação ou a da última atualização.

Opções disponíveis:
created,
updated

Resposta

200 - application/json

OK

data
object[]
meta
object
Exemplo: