Introdução

O Zaplin é um CRM de WhatsApp para equipes. Tudo o que um workspace tem (contatos, conversas, mensagens, pipelines, campanhas, automações, lembretes, formulários e segmentos) também está disponível por quatro portas:

Por onde começarCopiar link

• Integração entre sistemas (ERP, BI, seu backend): crie uma chave de API e siga o começo rápido.
• App para outros workspaces: registre um app OAuth.
• Assistente de IA: conecte o servidor MCP; a pessoa autoriza e o assistente age com o papel dela.
• Receber eventos: crie um endpoint de webhook, ou mande eventos de Stripe, Hotmart ou do seu sistema para uma automação.

Endereço baseCopiar link

Todas as rotas da API ficam em:

https://app.zaplin.com.br/api/v1

• Corpos e respostas em JSON, com chaves em snake_case (contact_id, next_cursor). Datas e horários em ISO 8601, em UTC.
• Telefones em E.164, como +5511987654321.
• Um corpo que não é JSON recebe 400 com invalid_json. Todo erro é { error: { code, message } } (veja Erros e limites).

A referência da API lista cada endpoint, gerada da mesma tabela de rotas que a API e o servidor MCP usam.

PaginaçãoCopiar link

As listas vêm do mais novo ao mais antigo, uma página por vez:

{
  "data": [{ "id": "…" }],
  "next_cursor": "eyJhdCI6IjIwMjYtMTAtMTdUMTM6MDI6MTEuMDAwWiIsImlkIjoi4oCmIn0"
}

next_cursor é null na última página. Trate o cursor como opaco: um cursor que não veio da API recebe 400 com invalid_cursor.

let cursor: string | null = null
do {
  const url = new URL("https://app.zaplin.com.br/api/v1/contacts")
  url.searchParams.set("limit", "100")
  if (cursor) url.searchParams.set("cursor", cursor)
  const response = await fetch(url, {
    headers: { Authorization: `Bearer ${process.env.ZAPLIN_KEY}` },
  })
  const page = await response.json()
  for (const contact of page.data) console.log(contact.id)
  cursor = page.next_cursor
} while (cursor)

Dois tipos de tokenCopiar link

Os dois vão no cabeçalho Authorization: Bearer <token>. Veja Autenticação.

Próximos passosCopiar link