# Pipelines e oportunidades

> Pipelines, etapas, oportunidades e comentários do CRM.

Endereço: https://docs.nextags.com.br/referencia/pipelines/
Tipo: Referência

O CRM em quadro da NexTags: cada pipeline tem etapas (as colunas) e oportunidades (os cartões), com o contato, o valor, o estado, a prioridade e os responsáveis. Use estas chamadas para levar ao pipeline as vendas e os atendimentos do seu sistema, mudar os cartões de etapa, fechar como ganho ou perdido e registrar comentários. O passo a passo está no guia [Criar e mover oportunidades no pipeline](https://docs.nextags.com.br/guias/oportunidades-no-pipeline/); a tela, em [O que é um pipeline](https://help.nextags.com.br/tutoriais/pipelines/o-que-e-um-pipeline/).

## Endpoints

- [Listar pipelines](https://docs.nextags.com.br/referencia/pipelines/listar-pipelines.md): `GET /pipelines`
- [Consultar pipeline](https://docs.nextags.com.br/referencia/pipelines/consultar-pipeline.md): `GET /pipelines/{pipeline_id}`
- [Listar etapas do pipeline](https://docs.nextags.com.br/referencia/pipelines/listar-etapas-do-pipeline.md): `GET /pipelines/{pipeline_id}/stages`
- [Listar campos do pipeline](https://docs.nextags.com.br/referencia/pipelines/listar-campos-do-pipeline.md): `GET /pipelines/{pipeline_id}/custom_fields`
- [Listar oportunidades](https://docs.nextags.com.br/referencia/pipelines/listar-oportunidades.md): `GET /pipelines/{pipeline_id}/opportunities`
- [Criar oportunidade](https://docs.nextags.com.br/referencia/pipelines/criar-oportunidade.md): `POST /pipelines/{pipeline_id}/opportunities`
- [Consultar oportunidade](https://docs.nextags.com.br/referencia/pipelines/consultar-oportunidade.md): `GET /pipelines/{pipeline_id}/opportunities/{opportunity_id}`
- [Atualizar oportunidade](https://docs.nextags.com.br/referencia/pipelines/atualizar-oportunidade.md): `POST /pipelines/{pipeline_id}/opportunities/{opportunity_id}`
- [Apagar oportunidade](https://docs.nextags.com.br/referencia/pipelines/apagar-oportunidade.md): `DELETE /pipelines/{pipeline_id}/opportunities/{opportunity_id}`
- [Transferir oportunidade de pipeline](https://docs.nextags.com.br/referencia/pipelines/transferir-oportunidade-de-pipeline.md): `POST /pipelines/{pipeline_id}/opportunities/{opportunity_id}/transfer-to-pipeline`
- [Listar comentários da oportunidade](https://docs.nextags.com.br/referencia/pipelines/listar-comentarios-da-oportunidade.md): `GET /pipelines/{pipeline_id}/opportunities/{opportunity_id}/comments`
- [Comentar na oportunidade](https://docs.nextags.com.br/referencia/pipelines/comentar-na-oportunidade.md): `POST /pipelines/{pipeline_id}/opportunities/{opportunity_id}/comments`
- [Apagar comentário](https://docs.nextags.com.br/referencia/pipelines/apagar-comentario.md): `DELETE /pipelines/{pipeline_id}/opportunities/{opportunity_id}/comments/{comment_id}`

## O objeto: Oportunidade

| Campo | Tipo | Descrição |
|---|---|---|
| `id` | integer | O ID da oportunidade. |
| `contact_id` | integer | O ID do contato. |
| `title` | string | O nome da oportunidade. |
| `description` | string | A descrição. |
| `value` | number | O valor, na moeda da conta. Não é em centavos: `1500` = R$ 1.500,00. |
| `status` | string | O estado: `open` (Aberto), `won` (Ganho; Resolvido nos pipelines de suporte e nos personalizados) ou `lost` (Perdido; Não Resolvido). Valores: `open`, `won`, `lost`. |
| `priority` | string | A prioridade: `low` (Baixa), `medium` (Média) ou `high` (Alta). Valores: `low`, `medium`, `high`. |
| `stage` | object | A etapa onde a oportunidade está. |
| `stage.id` | integer | O ID da etapa. |
| `stage.name` | string | O nome da etapa. |
| `assigned_admins` | array de integer | Os IDs dos administradores atribuídos. |
| `created_at` | string | Quando a oportunidade foi criada, em UTC. |
| `created_by` | integer | O ID do administrador que criou. |
| `updated_at` | string | A última mudança, em UTC. |
| `updated_by` | integer | O ID do administrador que fez a última mudança. |

```json
{
  "id": 4201,
  "contact_id": 123456789,
  "title": "Plano Pro anual",
  "description": "Quer começar em novembro, com 3 atendentes.",
  "value": 1500,
  "status": "open",
  "priority": "high",
  "stage": {
    "id": 4101,
    "name": "Novo lead"
  },
  "assigned_admins": [
    10001
  ],
  "created_at": "2026-10-20 14:30:00",
  "created_by": 10001,
  "updated_at": "2026-10-22 18:05:00",
  "updated_by": 10001
}
```