Listar negócios

Devolve os negócios da conta, do mais recente para o mais antigo, em páginas por cursor.

GET https://app.salos.com.br/api/deals deals:read

Filtros

Parâmetro Tipo O que faz
stage new, qualified, proposal_sent, negotiation, won, lost só os negócios naquele estágio
company_id uuid só os negócios daquela empresa
external_id texto o negócio com esse id do seu sistema
include contacts inclui a lista de contatos vinculados em cada negócio
limit número quantos por página (padrão 25, teto 999)
cursor texto o next_cursor da página anterior
format csv devolve CSV em vez de JSON
created_after · created_before · updated_after · updated_before data-hora ISO 8601 com fuso (2026-01-01T00:00:00Z) fatia por janela de tempo

⛔ Parâmetro fora desta lista devolve 400 — inclusive um owner_id bem-intencionado. Isso é proposital: um filtro silenciosamente ignorado devolveria a conta inteira parecendo um resultado filtrado.

Resposta

{
  "data": [
    {
      "id": "6d2c9f4e-1b7a-4e3d-8c5f-2a9b4d7e6f95",
      "name": "Reforma da fachada",
      "stage": "negotiation",
      "value": 18500.00,
      "company_id": "4e8b2f6d-7a1c-4d5e-9f4b-8a2c6e1d3b84",
      "owner_id": "1b7c9d2e-5f3a-4e8b-9c1d-2a6f4b8e3d57",
      "source": "Indicação",
      "funnel_id": "0a3f7c1e-6b2d-4a9f-8e5c-3d7b1f4a2c68",
      "column_id": "7e2b5d8a-4c1f-4b6e-9a3d-5f8c2e7b1d49",
      "expected_close_date": "2026-10-15",
      "actual_close_date": null,
      "lost_reason": null,
      "loss_reason_id": null,
      "notes": null,
      "external_id": "crm-legado-482",
      "custom_fields": {},
      "tags": [],
      "created_at": "2026-05-02T12:00:00.000Z",
      "updated_at": "2026-05-02T12:00:00.000Z"
    }
  ],
  "pagination": { "next_cursor": null }
}

Duas armadilhas

  • O campo tags some do JSON se a chave não tiver tags:read — não vem vazio, some. Quem lê negocio.tags.length quebra sem entender por quê.
  • stage e column_id descrevem a mesma coisa por dois caminhos. Quem move negócio pela API deve mandar column_id; o stage é derivado dele.