Visao geral

Todos os endpoints de listagem (GET) aceitam paginacao por page e limit. Use-os para percorrer grandes volumes de dados em lotes.

Parametros de query

Query params de paginacao

pagenumberopcionaldefault: 1

Numero da pagina, comecando em 1.

limitnumberopcionaldefault: 20 ou 50

Itens por pagina. O default varia por recurso (20 na maioria; 50 em mensagens e logs) e o maximo e 100.

sortOrderstringopcionaldefault: desc

Ordenacao quando suportada: asc ou desc. Disponivel, por exemplo, em mensagens de uma conversa.

Limite maximo

O limit e limitado a 100 nos endpoints que aplicam esse teto. Valores acima sao reduzidos para 100. Para volumes maiores, percorra varias paginas.

Formatos de resposta

Por evolucao historica, a API tem dois formatos de resposta paginada. Ambos trazem os mesmos dados — muda apenas onde a lista e os contadores ficam.

Formato 1 — envelope `data` + `pagination`

A lista vem em data e os contadores em um objeto pagination. Usado pelas listagens de email (templates e campanhas).

Formato 2 — chave nomeada + contadores no mesmo nivel

A lista vem em uma chave com o nome do recurso (ex: conversations, flows, messages) e os contadores total, page e totalPages ficam ao lado dela, dentro de data. Usado por conversas, mensagens e flows.

Confira o formato do recurso

Antes de consumir uma listagem, verifique na pagina do recurso qual formato ela retorna. A chave da lista (data, conversations, flows, templates, campaigns) e a localizacao dos contadores mudam entre os dois formatos.

Como percorrer todas as paginas

Comece com page=1.
Leia totalPages (ou compare page * limit com total).
Incremente page ate alcancar totalPages.

Exemplo:

Proximos passos

Conversas e Mensagens

Listagens com filtros e paginacao no formato de chave nomeada.

Email e Campanhas

Listagens no formato envelope data + pagination.