Visão geral da API

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

Aspecto	Como funciona
Formato	JSON em request e response
Autenticação	Header `api_access_token`
Identificadores	Inteiros (`account_id`, `inbox_id`, `conversation_id`…)
Datas	ISO 8601 (`"2026-05-18T14:23:11.000Z"`) ou timestamp Unix
Paginação	Query param `page` (1-indexed), 25 itens por página
Filtros	Query params (`?status=open&assignee_type=me`)
Erros	HTTP status code + body `{ "error": "mensagem" }`

Códigos de resposta

Código	Significado
`200 OK`	Requisição bem-sucedida
`201 Created`	Recurso criado
`204 No Content`	Sucesso sem corpo (DELETE)
`400 Bad Request`	Payload ou parâmetro inválido
`401 Unauthorized`	Token ausente ou inválido
`403 Forbidden`	Sem permissão pra ação
`404 Not Found`	Recurso não existe
`422 Unprocessable Entity`	Validação de negócio falhou
`429 Too Many Requests`	Rate limit estourado
`500 Internal Server Error`	Erro 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"

const res = await fetch(
  'https://chat.lfautomatiza.com/api/v1/accounts/1/conversations',
  { headers: { 'api_access_token': process.env.LF_TOKEN } }
);
console.log(await res.json());

import requests
r = requests.get(
    'https://chat.lfautomatiza.com/api/v1/accounts/1/conversations',
    headers={'api_access_token': TOKEN}
)
print(r.json())

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

Visão geral

Conversas e mensagens

Organização

Operação

Kanban

Base URL

Convenções

Códigos de resposta

Recursos disponíveis

Conversas

Mensagens

Contatos

Inboxes

Equipes e agentes

Labels

Atributos personalizados

Campanhas

Regras de automação

Macros

Respostas rápidas

Relatórios

Webhooks (API)

Kanban

Primeira chamada

Próximos passos

Autenticação

Rate limits

Webhooks

API Kanban

​Base URL

​Convenções

​Códigos de resposta

​Recursos disponíveis

Conversas

Mensagens

Contatos

Inboxes

Equipes e agentes

Labels

Atributos personalizados

Campanhas

Regras de automação

Macros

Respostas rápidas

Relatórios

Webhooks (API)

Kanban

​Primeira chamada

​Próximos passos

Autenticação

Rate limits

Webhooks

API Kanban

Base URL

Convenções

Códigos de resposta

Recursos disponíveis

Primeira chamada

Próximos passos