Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.lfautomatiza.com/llms.txt

Use this file to discover all available pages before exploring further.

A API do LF Connect é REST, retorna JSON, autentica via header api_access_token e segue padrões previsíveis em toda a base.

​
Base URL

https://chat.lfautomatiza.com/api/v1
A maioria dos endpoints é escopada por conta (workspace) e segue o padrão: 
/api/v1/accounts/{account_id}/{recurso}

​
Convenções

AspectoComo funciona
FormatoJSON em request e response
AutenticaçãoHeader api_access_token
IdentificadoresInteiros (account_id, inbox_id, conversation_id…)
DatasISO 8601 ("2026-05-18T14:23:11.000Z") ou timestamp Unix
PaginaçãoQuery param page (1-indexed), 25 itens por página
FiltrosQuery params (?status=open&assignee_type=me)
ErrosHTTP status code + body { "error": "mensagem" }

​
Códigos de resposta

CódigoSignificado
200 OKRequisição bem-sucedida
201 CreatedRecurso criado
204 No ContentSucesso sem corpo (DELETE)
400 Bad RequestPayload ou parâmetro inválido
401 UnauthorizedToken ausente ou inválido
403 ForbiddenSem permissão pra ação
404 Not FoundRecurso não existe
422 Unprocessable EntityValidação de negócio falhou
429 Too Many RequestsRate limit estourado
500 Internal Server ErrorErro do servidor (abre ticket)

​
Recursos disponíveis

Conversas

CRUD, atribuição, labels, status, filtros avançados

Mensagens

Enviar texto, mídia, templates aprovados, notas privadas

Contatos

Criar, listar, importar CSV, segmentar, mesclar

Inboxes

Canais, horário comercial, agentes vinculados

Equipes e agentes

Convidar agentes, gerenciar equipes e membros

Labels

CRUD de etiquetas usadas em conversas e contatos

Atributos personalizados

Campos customizados pra conversas e contatos

Campanhas

One-off e ongoing, audiência por labels, agendamento

Regras de automação

Evento → Condição → Ação, sem código

Macros

Sequências executadas manualmente pelo agente

Respostas rápidas

Textos pré-definidos com atalho /

Relatórios

Métricas de conversas, agentes, equipes, CSAT

Webhooks (API)

Cadastrar e gerenciar webhooks programaticamente

Kanban

Funis, cards, automações, importação

​
Primeira chamada

Liste suas conversas pra confirmar que tudo está conectado: 
curl https://chat.lfautomatiza.com/api/v1/accounts/1/conversations \
  -H "api_access_token: SEU_TOKEN"
Resposta esperada: 
{
  "data": {
    "meta": {
      "all_count": 47,
      "mine_count": 12
    },
    "payload": [
      {
        "id": 123,
        "status": "open",
        "contact": {
          "name": "Carlos Antônio",
          "phone_number": "+5521999544338"
        },
        "messages_count": 4
      }
    ]
  }
}

​
Próximos passos

Autenticação

Como pegar token e enviar nas requisições

Rate limits

Tetos, headers e como evitar 429

Webhooks

Reagir a eventos em tempo real

API Kanban

Pipeline comercial via API