Skip to main content
POST
Listar todos os grupos com filtros e paginacao

Autorizações

token
string
header
obrigatório

Corpo

application/json
page
integer
padrão:1

Numero da pagina para paginacao (padrao 1)

pageSize
integer
padrão:50

Quantidade de resultados por pagina (padrao 50, maximo 1000)

limit
integer

Alias opcional para pageSize

offset
integer
padrão:0

Deslocamento base zero; se informado recalcula a pagina

Texto para filtrar grupos por nome/JID

force
boolean
padrão:false

Se definido como true, forca a atualizacao do cache de grupos. Util para garantir que as informacoes mais recentes sejam recuperadas.

noParticipants
boolean
padrão:false

Se definido como true, retorna a lista de grupos sem incluir os participantes. Util para otimizar a resposta quando nao ha necessidade dos dados dos participantes.

Resposta

Lista de grupos recuperada com sucesso

groups
object[]

Lista detalhada de grupos

pagination
object