Skip to main content

Endpoint

GET /v1/deals
Escopo necessário: read:deals — disponível nos planos Growth e Scale

Parâmetros de query

ParâmetroTipoDescrição
limitintegerItens por página. Padrão: 25. Máximo: 100
cursorstringToken de paginação
pipeline_idstringFiltra por pipeline
stage_idstringFiltra por etapa
statusstringopen, won, lost
assigned_tostringID do membro responsável
contact_idstringID do contato vinculado
company_idstringID da empresa vinculada
tagstringTag exata
min_valuenumberValor mínimo do negócio
max_valuenumberValor máximo do negócio
created_afterstringISO 8601
created_beforestringISO 8601
expected_close_beforestringISO 8601 — data prevista de fechamento

Exemplo de requisição

curl "https://api.socialsell.ai/v1/deals?status=open&pipeline_id=664a1b2c3d4e5f6789012345&min_value=5000" \
  -H "Authorization: Bearer sk_live_..."

Exemplo de resposta

{
  "data": [
    {
      "id": "664c1d2e3f4a5b6789012347",
      "title": "Proposta Enterprise ACME",
      "description": "Implantação do módulo de automações",
      "value": 18000,
      "status": "open",
      "pipeline": {
        "id": "664a1b2c3d4e5f6789012345",
        "name": "Funil Principal"
      },
      "stage": {
        "name": "Proposta enviada"
      },
      "assigned_to": {
        "id": "664a1b2c3d4e5f6789012345",
        "name": "Maria Santos"
      },
      "contacts": [
        { "id": "664f1a2b3c4d5e6f78901234", "name": "João Silva" }
      ],
      "company": {
        "id": "664b1c2d3e4f5a6789012346",
        "name": "ACME Corp"
      },
      "tags": ["enterprise", "q2"],
      "probability": 70,
      "expected_close_date": "2026-07-31T00:00:00.000Z",
      "closed_date": null,
      "custom_fields": {},
      "created_at": "2026-05-01T09:00:00.000Z",
      "updated_at": "2026-06-05T16:30:00.000Z"
    }
  ],
  "meta": {
    "total": 45,
    "has_more": false,
    "next_cursor": null
  }
}

Objeto negócio

CampoTipoDescrição
idstringID único
titlestringTítulo do negócio
descriptionstring|nullDescrição
valuenumberValor em reais
statusstringopen, won, lost
pipelineobject|nullFunil de venda {id, name}
stageobject|nullEtapa {name}
assigned_toobject|nullResponsável {id, name}
contactsarrayContatos vinculados [{id, name}]
companyobject|nullEmpresa {id, name}
tagsstring[]Tags
probabilityintegerProbabilidade de fechamento (0–100)
expected_close_datestring|nullData prevista de fechamento
closed_datestring|nullData de fechamento real
custom_fieldsobjectCampos personalizados
created_atstringTimestamp de criação
updated_atstringTimestamp de atualização