Listar Oportunidades

GET /external/v1/opportunities

Retorna uma lista paginada de todas as oportunidades/leads nos seus pipelines. Cada oportunidade carrega o contato vinculado, pipeline, etapa e timestamps de ciclo de vida.

Autenticacao

Requer permissao opportunities:read.

Parametros de Query

Parametro	Tipo	Padrao	Descricao
page	integer	1	Numero da pagina
limit	integer	50	Itens por pagina (1-100)
search	string	-	Buscar por titulo da oportunidade, nome do contato ou empresa
stage_id	string	-	Filtrar por etapa
pipeline_id	string	-	Filtrar por pipeline
campaign_id	string	-	Filtrar por campanha
owner_user_id	string	-	Filtrar por vendedor responsavel
company	string	-	Filtrar por empresa do contato
created_after	string (ISO 8601)	-	Apenas oportunidades criadas a partir deste timestamp
created_before	string (ISO 8601)	-	Apenas oportunidades criadas ate este timestamp
updated_after	string (ISO 8601)	-	Apenas oportunidades atualizadas a partir deste timestamp
updated_before	string (ISO 8601)	-	Apenas oportunidades atualizadas ate este timestamp
sort_by	string	created_at	Campo de ordenacao (created_at, updated_at, title, value)
sort_order	string	desc	Ordem (asc, desc)

Sync incremental

Puxe so o que mudou desde o ultimo sync: GET /opportunities?updated_after=2026-06-08T00:00:00Z&sort_by=updated_at&sort_order=asc. Data invalida retorna 400 VALIDATION_ERROR.

TIP

O status de uma oportunidade e representado pela etapa dentro de um pipeline, nao por um enum fixo. Use Listar Pipelines para resolver stage_id / pipeline_id em nomes.

Requisicao

cURL

curl --request GET \
  --url "https://app.getraze.com/external/v1/opportunities?pipeline_id=pipe_01&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: { pipeline_id: 'pipe_01', 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={'pipeline_id': 'pipe_01', 'limit': 50}
)

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",
      "pipeline_id": "pipe_01",
      "pipeline_name": "Vendas",
      "stage_id": "stg_proposal",
      "stage_name": "Proposta",
      "campaign_id": "camp_xyz789",
      "campaign_name": "Q1 Outreach",
      "owner_user_id": "usr_123",
      "owner_user_name": "Maria Silva",
      "owner_user_email": "maria@acme.com",
      "sector_id": "sec_01",
      "discard_reason_id": null,
      "score": 85,
      "source": "linkedin",
      "notes": "Interessado no plano enterprise",
      "sent_at": "2026-01-15T10:30:00Z",
      "accepted_at": "2026-01-16T09:00:00Z",
      "qualifying_started_at": "2026-01-16T09:05:00Z",
      "qualified_at": "2026-01-17T11:00:00Z",
      "scheduled_at": null,
      "won_at": null,
      "lost_at": null,
      "created_at": "2026-01-15T10:30:00Z",
      "updated_at": "2026-01-20T14:00:00Z",
      "contact_id": "cnt_abc123",
      "contact_name": "John Doe",
      "contact_email": "john@example.com",
      "contact_phone": "+5511999999999",
      "contact_company": "Acme Inc",
      "contact_title": "CEO",
      "contact_location": "Sao Paulo, BR",
      "contact_profile_url": "https://linkedin.com/in/johndoe",
      "contact_profile_picture": "https://cdn.getraze.com/c/abc.jpg"
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 50,
    "total": 85,
    "total_pages": 2,
    "has_next": true,
    "has_prev": false
  }
}

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 (BRL, USD, EUR)
probability	integer	Probabilidade de fechamento (%)
expected_close_date	string	Data prevista de fechamento
pipeline_id / pipeline_name	string	Pipeline da oportunidade
stage_id / stage_name	string	Etapa atual
campaign_id / campaign_name	string	Campanha associada (nullable)
owner_user_id / owner_user_name / owner_user_email	string	Vendedor responsavel (nullable)
sector_id	string	Setor/time (nullable)
discard_reason_id	string	Motivo de perda quando descartada (nullable)
score	integer	Score do lead
source	string	Origem do lead
sent_at … lost_at	string	Timestamps de ciclo de vida por etapa (nullable)
contact_*	string	Resumo do contato vinculado
pagination	object	Metadados de paginacao