---
title: "Listar negociações"
method: GET
path: "/deals"
tags: ["crm-v2-deals"]
---

# Listar negociações

`GET /deals`

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](crm-v2-rdql-filtering).

| 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](crm-v2-introduction#ordenação).

* `name`
* `rating`
* `created_at`
* `updated_at`
* `closed_at`

## Query parameters

- `filter` string
- `sort` object
- `page` object
  - `number` integer — Número da página.
  - `size` integer — Tamanho da página.

## Response `200`

OK

- object
  - `data` object[] — Lista de recursos relacionados.
    - `id` string — Identificador único.
    - `name` string — Nome da negociação.
    - `recurrence_price` number, float — Valor recorrente da negociação.
    - `one_time_price` number, float — Valor único da negociação.
    - `total_price` number, float — Valor total da negociação.
    - `expected_close_date` string, date — Data de previsão de fechamento da negociação.
    - `rating` integer — Qualificação da negociação.
    - `status` 'won' | 'lost' | 'ongoing' | 'paused' — Status da negociação.
    - `closed_at` string, date-time — Data de fechamento da negociação.
    - `pipeline_id` string — ID do funil de vendas da negociação.
    - `stage_id` string — ID da etapa do funil de vendas da negociação.
    - `owner_id` string — ID do usuário responsável pela negociação.
    - `source_id` string — ID da fonte da negociação.
    - `campaign_id` string — ID da campanha da negociação.
    - `lost_reason_id` string — ID do motivo de perda da negociação.
    - `organization_id` string — ID da empresa associada à negociação.
    - `contact_ids` string[] — IDs dos contatos associados à negociação.
    - `custom_fields` CustomFields
    - `distribution_settings` DistributionSetting
      - `stage_id` string — ID da etapa do funil de vendas da negociação.
      - `rule` object — Configurações para seleção do usuário para receber a negociação.
        - `type` 'user' | 'team' | 'all' | 'all_users' | 'all_admins' | 'owner' — Tipo de distribuição.
        - `id` string — Identificador do time ou usuário para distribuição da negociação.
        - `email` string — Email do usuário para distribuir a negociação.
    - `created_at` string, date-time — Data de criação da negociação.
    - `updated_at` string, date-time — Data de atualização da negociação.
  - `links` object — Links de navegação da paginação.
    - `first` string, uri — Link para a primeira página.
    - `prev` string, uri — Link para a página anterior.
    - `self` string, uri — Link para a página atual.
    - `next` string, uri — Link para a próxima página.
    - `last` string, uri — Link para a última página.

## Other responses

- `400` — A requisição está malformada e não consegue ser processada.
- `401` — O token da API está ausente ou inválido.
- `403` — O token não tem permissão para acessar o recurso solicitado.
- `429` — O limite de requisições foi excedido.
- `500` — Internal Server Error

---

[API](https://skmtc.net/rdstation/apis/webhook-service.md) · [All operations](https://skmtc.net/rdstation/apis/webhook-service/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/rdstation/webhook-service/revisions/3867c21388e8/schema)