Buscar Oportunidade

GET /external/v1/opportunities/:id

Recupera uma oportunidade/lead especifica pelo ID, incluindo o contato, pipeline/etapa, setor, motivo de descarte, itens de produto e comentarios internos.

Autenticacao

Requer permissao opportunities:read.

Parametros de Caminho

Parametro	Tipo	Obrigatorio	Descricao
id	string	Sim	Identificador unico da oportunidade

Requisicao

cURL

curl --request GET \
  --url "https://app.getraze.com/external/v1/opportunities/opp_abc123def456" \
  --header "X-API-Key: YOUR_API_KEY"

Node.js

const axios = require('axios');

const opportunityId = 'opp_abc123def456';

const response = await axios.get(
  `https://app.getraze.com/external/v1/opportunities/${opportunityId}`,
  { headers: { 'X-API-Key': 'YOUR_API_KEY' } }
);

console.log(response.data);

Python

import requests

opportunity_id = 'opp_abc123def456'

response = requests.get(
    f'https://app.getraze.com/external/v1/opportunities/{opportunity_id}',
    headers={'X-API-Key': 'YOUR_API_KEY'}
)

print(response.json())

Resposta

{
  "success": true,
  "data": {
    "id": "opp_abc123def456",
    "title": "Acme Inc - Plano Pro",
    "value": 50000.00,
    "currency": "BRL",
    "probability": 60,
    "expected_close_date": "2026-03-31",
    "score": 85,
    "source": "linkedin",
    "notes": "Interessado no plano enterprise",
    "pipeline_id": "pipe_01",
    "pipeline_name": "Vendas",
    "stage_id": "stg_proposal",
    "stage_name": "Proposta",
    "sector_id": "sec_01",
    "sector_name": "Inbound",
    "discard_reason_id": null,
    "discard_reason": null,
    "campaign_id": "camp_xyz789",
    "owner_user_id": "usr_123",
    "contact_id": "cnt_abc123",
    "contact_name": "John Doe",
    "contact_email": "john@example.com",
    "contact_phone": "+5511999999999",
    "contact_company": "Acme Inc",
    "contact_title": "CEO",
    "campaign_name": "Q1 Outreach",
    "owner_user_name": "Maria Silva",
    "owner_user_email": "maria@acme.com",
    "sent_at": "2026-01-15T10:30:00Z",
    "won_at": null,
    "lost_at": null,
    "created_at": "2026-01-15T10:30:00Z",
    "updated_at": "2026-01-20T14:00:00Z",
    "products": [
      {
        "id": "opx_01",
        "product_id": "prod_01",
        "name": "Plano Pro",
        "quantity": 1,
        "unit_price": 199.00,
        "total_price": 199.00,
        "discount_percent": 0,
        "discount_value": 0
      }
    ],
    "comments": [
      {
        "id": "cmt_01",
        "content": "Falei com o CFO, enviando proposta.",
        "user_name": "Maria Silva",
        "created_at": "2026-01-18T11:00:00Z"
      }
    ]
  }
}

Campos de Resposta

Campo	Tipo	Descricao
id	string	Identificador unico da oportunidade
title	string	Titulo da oportunidade
value	number	Valor da oportunidade
currency	string	Codigo de moeda
probability	integer	Probabilidade de fechamento (%)
expected_close_date	string	Data prevista de fechamento
score	integer	Score do lead
source	string	Origem do lead
notes	string	Notas adicionais
pipeline_id / pipeline_name	string	Pipeline
stage_id / stage_name	string	Etapa atual
sector_id / sector_name	string	Setor/time (nullable)
discard_reason_id / discard_reason	string	Motivo de perda quando descartada (nullable)
campaign_id / campaign_name	string	Campanha associada (nullable)
owner_user_id / owner_user_name / owner_user_email	string	Vendedor responsavel (nullable)
contact_*	string	Resumo do contato vinculado
sent_at … lost_at	string	Timestamps de ciclo de vida por etapa (nullable)
products	array	Itens de produto/servico (product_id, name, quantity, unit_price, total_price, descontos)
comments	array	Comentarios internos (id, content, user_name, created_at)

TIP

Precisa da trilha completa de mudancas de etapa (timestamps de entrada/saida por etapa)? Use Historico da Oportunidade.

Erros

Status	Codigo	Descricao
404	NOT_FOUND	Oportunidade nao encontrada