ReferênciaNegócios
Listar negócios
GET /deals — lista os negócios da organização com filtros por pipeline, etapa, responsável, contato, status, external_id e sync incremental.
GET
/dealsBetaEscopo necessário: deals:read
Lista os negócios da organização (resolvida pela API key), em ordem de updated_at decrescente. Suporta paginação por limit/offset.
Endpoint
GET https://crm.oficinamartech.com/api/v1/dealsParâmetros de query
| Parâmetro | Tipo | Descrição |
|---|---|---|
pipeline_id | UUID | Filtra por pipeline. |
stage_id | UUID | Filtra por etapa. |
assigned_to | UUID | Filtra pelo responsável (user_id de GET /members). |
contact_id | UUID | Filtra por contato vinculado. |
status | open | won | lost | Filtra por status. |
external_id | string (até 200) | Filtra pelo id externo de idempotência (external_id do POST /deals). |
created_since | date | Somente negócios criados a partir desta data (inclusive). ISO 8601 ou YYYY-MM-DD. |
updated_since | date | Somente negócios atualizados a partir desta data (inclusive). ISO 8601 ou YYYY-MM-DD. |
limit | int (1-100) | Tamanho da página. Default: 50. |
offset | int | Deslocamento da página. Default: 0. |
external_id casa apenas com negócios criados pela API (POST /deals com external_id). Use-o para verificar se um lead externo já virou negócio antes de reenviar.
Exemplo
curl -s "https://crm.oficinamartech.com/api/v1/deals?status=open&limit=2" \
-H "Authorization: Bearer crm_live_SEU_PREFIXO_SEU_SEGREDO"Resposta 200
{
"data": [
{
"id": "9b2e1c40-58cc-4372-a567-0e02b2c3d479",
"organization_id": "0a1b2c3d-4e5f-6789-abcd-ef0123456789",
"pipeline_id": "11111111-2222-3333-4444-555555555555",
"stage_id": "66666666-7777-8888-9999-aaaaaaaaaaaa",
"contact_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"product_id": null,
"assigned_to": "44444444-4444-4444-8444-444444444444",
"title": "Proposta plano Pro",
"value": 1990.0,
"currency": "BRL",
"status": "open",
"source": "api",
"expected_close_date": "2026-07-31",
"won_at": null,
"lost_at": null,
"lost_reason": null,
"metadata": { "campanha": "black-friday" },
"created_via": "api",
"dedup_key": "lead-2026-000123",
"created_at": "2026-06-20T11:00:00.000Z",
"updated_at": "2026-07-01T16:40:10.000Z"
}
],
"pagination": {
"limit": 2,
"offset": 0,
"count": 1,
"has_more": false,
"next_offset": null
}
}Erros
| Status | Código | Quando |
|---|---|---|
400 | — | Query inválida (UUID malformado, status desconhecido, data inválida). |
401 | missing_api_key / invalid_api_key | API key ausente, inválida, expirada ou revogada. |
403 | missing_scope | A chave não tem o escopo deals:read. |
429 | rate_limited | Acima de 120 req/min por chave ou por organização. |
500 | — | Erro interno. |