Exportação em CSV
GET/api/contacts, /api/companies, /api/deals e /api/tasks aceitam ?format=csv, com o mesmo escopo :read de sempre. GET/api/products?format=csv também existe,…
GET/api/contacts, /api/companies, /api/deals e /api/tasks aceitam ?format=csv, com o mesmo
escopo :read de sempre. GET/api/products?format=csv também existe, com colunas e regras
próprias — ver a referência de Produtos; o resto desta seção fala dos quatro acima.
GET/api/deals?format=csv&limit=500- Resposta
200comcontent-type: text/csv; charset=utf-8— o corpo é o CSV puro, sem o envelope{"data": ...}. - Separador
;, quebra de linha\r\ne BOM UTF-8 no início — é o que faz o Excel em português abrir sem quebrar acento. - Células que começariam com
=,+,@, TAB ou retorno de carro são neutralizadas com uma aspa simples, para que um texto salvo no CRM não vire fórmula executável ao abrir a planilha. O-também, exceto quando o que vem depois é um número puro:-1234.56sai limpo, porque neutralizar valor negativo estragaria a planilha de quem só quer somar a coluna. ?limit=aceita até 999 neste formato (o padrão já é 999).- A paginação vem no cabeçalho
x-salos-next-cursor, não no corpo. Cabeçalho ausente significa última página. - O campo
tagsnão sai no CSV — não cabe numa célula. - A resposta traz
content-disposition: attachment; filename="contacts.csv"(o nome do arquivo segue o recurso), então o navegador baixa em vez de exibir.
| Recurso | Colunas, nesta ordem |
|---|---|
| Contatos | id, name, email, phone, title, company_id, instagram, messenger_id, external_id, created_at, updated_at + uma coluna por campo personalizado |
| Empresas | id, name, notes, cnpj, legal_name, segment, size, phone, email, website, zip_code, street, street_number, complement, neighborhood, city, state, created_at + uma coluna por campo personalizado |
| Negócios | id, name, stage, value, company_id, owner_id, funnel_id, column_id, expected_close_date, lost_reason, notes, created_at + uma coluna por campo personalizado |
| Tarefas | id, title, description, status, priority, due_date, assigned_to, contact_id, company_id, deal_id, created_at |
⛔ Só Contatos exporta
external_ideupdated_at. Empresas, Negócios e Tarefas não trazem essas duas colunas. ⛒ E o CSV se lê por POSIÇÃO em planilha e em ETL — confira a linha de cabeçalho antes de mapear coluna por índice, nunca decore a posição."+ uma coluna por campo personalizado" — Contatos, Empresas e Negócios têm campo personalizado (§28); o CSV ganha uma coluna a mais no fim para cada definição cadastrada naquele tipo, com o
labelcomo cabeçalho, na mesma ordem da tela. Conta sem nenhuma definição não ganha coluna extra nenhuma. Tarefas não têm campo personalizado.