Skip to main content
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}.
Listagens de entidades com CRUD completo têm sua própria página de referência: Contatos, Tickets, Oportunidades e Campanhas também expõem os mesmos endpoints de listagem documentados aqui — eles estão descritos nesta página para centralizar a referência de descoberta de dados.

Listar todas as integrações de API

Retorna todas as integrações de API (sessões de acesso externo) cadastradas no tenant.

Listar canais

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

Listar sessões

Retorna todas as sessões do WhatsApp cadastradas — uma visão focada em canais WhatsApp especificamente (veja também Canais e Sessões).

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)

Equivalente por GET ao endpoint POST /contacts/search documentado em Pesquisar contatos.

Listar tickets

Documentado em detalhe em Listar tickets.

Listar oportunidades

Documentado em detalhe em Listar oportunidades.

Listar respostas automáticas

Retorna as respostas automáticas configuradas (mensagens de saudação, ausência, horário de atendimento, etc.).

Listar respostas rápidas

Retorna os atalhos de resposta rápida cadastrados 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

Endpoints paginados (listContacts, listTickets, listOpportunities) retornam data como um objeto com o array de resultados mais metadados de paginação; os demais retornam data diretamente como array.