Buscar Oportunidade

GET /external/v1/opportunities/:id

Recupera os detalhes de uma oportunidade/lead especifica pelo ID.

Autenticacao

Requer permissao opportunities:read.

Parametros de Caminho

Parametro	Tipo	Obrigatorio	Descricao
id	string	Sim	O 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",
    "name": "John Doe",
    "email": "john@example.com",
    "phone": "+5511999999999",
    "company": "Acme Inc",
    "position": "CEO",
    "status": "qualified",
    "source": "linkedin",
    "deal_value": 50000.00,
    "deal_currency": "BRL",
    "linkedin_url": "https://linkedin.com/in/johndoe",
    "notes": "Interested in enterprise plan",
    "campaign": {
      "id": "camp_xyz789",
      "name": "Q1 Outreach"
    },
    "responsible_user": {
      "id": "usr_123",
      "name": "Sales Rep"
    },
    "won_at": null,
    "lost_at": null,
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-20T14:00:00Z"
  }
}

Campos da Resposta

Campo	Tipo	Descricao
id	string	Identificador unico da oportunidade
name	string	Nome completo do lead
email	string	Endereco de e-mail
phone	string	Numero de telefone
company	string	Nome da empresa
position	string	Cargo
status	string	Status no pipeline
source	string	Origem do lead
deal_value	number	Valor do negocio
deal_currency	string	Codigo da moeda
notes	string	Observacoes adicionais
campaign	object	Informacoes da campanha associada
responsible_user	object	Informacoes do usuario responsavel
won_at	string	Timestamp de quando foi marcado como ganho
lost_at	string	Timestamp de quando foi marcado como perdido

Erros

Status	Codigo	Descricao
404	NOT_FOUND	Oportunidade nao encontrada