v1
latestOpenAPI 3.0.32026-07-2431396640.5 KBcrm-v2-deals
Listar negociações
Este end-point recupera uma lista paginada de todas as negociações na conta, permitindo a filtragem por diversos critérios, como funil, etapa ou proprietário. É útil para sincronizar dados de negociações com sistemas externos ou para construir painéis de visualização personalizados.
Filtro
Propriedades disponíveis para filtro usando RDQL.
| Propriedade | Tipo | Descrição |
|---|---|---|
| id | String | Filtra por um ou mais IDs de negociação. |
| name | String | Filtra por nome da negociação, suportando busca exata ou por correspondência (usando operador match ~). |
| rating | Integer | Filtra por um valor de classificação numérica da negociação. |
| status | String | Filtra por status da negociação. |
| closed_at | DateTime | Filtra por data e hora de fechamento da negociação. |
| created_at | DateTime | Filtra por data e hora de criação da negociação. |
| updated_at | DateTime | Filtra por data e hora da última atualização da negociação. |
| expected_close_date | Date | Filtra pela data de fechamento prevista da negociação. |
| organization_id | String | Filtra por um ID de empresa. |
| contact_id | String | Filtra por um ou mais IDs de contato. |
| stage_id | String | Filtra por um ID de etapa do funil de vendas. |
| lost_reason_id | String | Filtra por um ID de motivo de perda da negociação. |
| campaign_id | String | Filtra por um ID de campanha. |
| owner_id | String | Filtra por um ID de proprietário (usuário) da negociação. |
| pipeline_id | String | Filtra negociações por um ID de funil de vendas. |
| product_ids | String | Filtra negociações que contêm um ou mais IDs de produtos. |
| has:product | Boolean | Filtra negociações que têm produtos associados. |
| @<custom_field_slug> | String | Filtra por um campo personalizado. Exemplo: filial:norte, erp_id:123. |
Ordenação
Propriedades disponíveis para ordenação.
- name
- rating
- created_at
- updated_at
- closed_at
get/deals
Query parameters
filterstring
Filtro no formato RDQL. (Saiba mais)
sortobject
Ordenação. (Saiba mais)
Paginação. (Saiba mais)
Response
OK