Listar Oportunidades

GET /external/v1/opportunities

Retorna uma lista paginada de todas as oportunidades/leads no seu pipeline.

Autenticacao

Requer permissao opportunities:read.

Parametros de Query

Parametro	Tipo	Padrao	Descricao
page	integer	1	Numero da pagina para paginacao
limit	integer	20	Itens por pagina (1-100)
search	string	-	Buscar por nome, e-mail ou empresa
status	string	-	Filtrar por status
source	string	-	Filtrar por origem (linkedin, google_maps, list, paid_traffic, other)
campaign_id	string	-	Filtrar por ID da campanha
responsible_user_id	string	-	Filtrar por ID do usuario responsavel
sort_by	string	created_at	Campo de ordenacao
sort_order	string	desc	Ordem (asc, desc)

Valores de Status Disponiveis

• new - Novo lead
• contacted - Primeiro contato realizado
• qualified - Lead qualificado
• proposal - Proposta enviada
• negotiation - Em negociacao
• won - Negocio ganho
• lost - Negocio perdido

Requisicao

cURL

curl --request GET \
  --url "https://app.getraze.com/external/v1/opportunities?status=qualified&limit=50" \
  --header "X-API-Key: YOUR_API_KEY"

Node.js

const axios = require('axios');

const response = await axios.get('https://app.getraze.com/external/v1/opportunities', {
  headers: {
    'X-API-Key': 'YOUR_API_KEY'
  },
  params: {
    status: 'qualified',
    limit: 50
  }
});

console.log(response.data);

Python

import requests

response = requests.get(
    'https://app.getraze.com/external/v1/opportunities',
    headers={'X-API-Key': 'YOUR_API_KEY'},
    params={'status': 'qualified', 'limit': 50}
)

print(response.json())

Resposta

{
  "success": true,
  "data": {
    "opportunities": [
      {
        "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",
        "campaign_id": "camp_xyz789",
        "responsible_user_id": "usr_123",
        "created_at": "2024-01-15T10:30:00Z",
        "updated_at": "2024-01-20T14:00:00Z"
      }
    ],
    "pagination": {
      "page": 1,
      "limit": 50,
      "total": 85,
      "total_pages": 2
    }
  }
}

Campos da Resposta

Campo	Tipo	Descricao
opportunities	array	Lista de objetos de oportunidade
id	string	Identificador unico da oportunidade
status	string	Status atual no pipeline
source	string	Origem do lead
deal_value	number	Valor estimado ou fechado do negocio
deal_currency	string	Codigo da moeda (BRL, USD, EUR)
campaign_id	string	ID da campanha associada
responsible_user_id	string	ID do usuario responsavel
pagination	object	Metadados de paginacao