Pular para o conteúdo principal
Esta página reúne endpoints de listagem simples (sem criação, atualização ou exclusão), usados para descobrir IDs e configurações disponíveis no seu tenant antes de usá-los em outras chamadas (por exemplo, obter um queueId válido antes de chamar Atualizar fila do ticket). Todas as requisições exigem o cabeçalho Authorization: Bearer {BearerToken}.
As listagens de contatos, tickets e oportunidades também aparecem na página de referência de cada entidade (Contatos, Tickets e Oportunidades); elas estão repetidas aqui para centralizar a descoberta de dados. A listagem de campanhas fica em Campanhas.

Listar todas as integrações de API

Retorna todas as integrações de API (sessões de acesso externo) cadastradas no tenant. Cada item traz o id da integração (o mesmo {ApiID} usado na URL), name, isActive e o canal vinculado (sessionId e o objeto session, com nome, tipo e status). Use para descobrir o ApiID de cada integração criada em Configuração → API.

Listar canais

Retorna todos os canais (WhatsApp, Instagram, Messenger, Webmail, etc.) cadastrados no tenant.

Listar sessões

Retorna as sessões do WhatsApp cadastradas, com o tipo e o status de conexão de cada uma (veja também Canais e Sessões). Use para conferir se um canal está conectado antes de enviar mensagens e para obter o whatsappId exigido por várias rotas.

Listar filas

Para criar, atualizar ou excluir filas, veja Kanban, Tags, Motivos e Filas.

Listar tags

Para criar, atualizar ou excluir tags, veja Kanban, Tags, Motivos e Filas.

Listar contatos (paginado)

Cada contato retornado também traz o endereço: cep, logradouro, numeroEndereco, complemento, bairro, cidade e estado. Para combinar vários filtros ou filtrar contatos bloqueados, use o POST /contacts/search, documentado em Pesquisar contatos.

Listar tickets

Documentado em detalhe em Listar tickets.

Listar oportunidades

Aceita filtros por status, pipeline, etapa, responsável, faixa de valor, data de criação e busca por texto, além da ordenação. A Privacidade do Funil (Configurações Gerais) não se aplica à API: a listagem traz as oportunidades de toda a empresa. Documentado em detalhe em Listar oportunidades.

Listar respostas automáticas

Retorna as respostas automáticas (auto respostas) configuradas no tenant.

Listar respostas rápidas

Retorna as Mensagens Rápidas cadastradas para uso dos agentes durante o atendimento.

Listar fluxos de chatbot

Retorna os fluxos de chatbot (chat flows) cadastrados, incluindo seus IDs: use o id retornado no campo chatFlowId de Criar ticket ou Atualizar informações do ticket.

Resposta Padrão

A maioria das listagens devolve a lista direto em data, com a paginação em um bloco pagination ao lado: