Consultar oportunidade
/pipelines/{pipeline_id}/opportunities/{opportunity_id}Devolve uma oportunidade: o contato, o título, o valor, o estado, a prioridade, a etapa, os responsáveis e as datas.
curl "https://app.nextagsai.com.br/api/pipelines/4001/opportunities/4201" \
-H "X-ACCESS-TOKEN: $NEXTAGS_API_KEY"
const resposta = await fetch('https://app.nextagsai.com.br/api/pipelines/4001/opportunities/4201', {
headers: {
'X-ACCESS-TOKEN': process.env.NEXTAGS_API_KEY,
},
});
const dados = await resposta.json();
console.log(resposta.status, dados);
import os
import requests
resposta = requests.get(
"https://app.nextagsai.com.br/api/pipelines/4001/opportunities/4201",
headers={"X-ACCESS-TOKEN": os.environ["NEXTAGS_API_KEY"]},
timeout=30,
)
print(resposta.status_code, resposta.json())
<?php
$ch = curl_init('https://app.nextagsai.com.br/api/pipelines/4001/opportunities/4201');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'X-ACCESS-TOKEN: ' . getenv('NEXTAGS_API_KEY'),
],
]);
$dados = json_decode(curl_exec($ch), true);
echo curl_getinfo($ch, CURLINFO_HTTP_CODE), PHP_EOL;
print_r($dados);
Autenticação
Mande a chave de API da conta no cabeçalho X-ACCESS-TOKEN de cada chamada. Veja Autenticação com a chave de API.
Parâmetros de caminho
pipeline_idintegerobrigatórioO ID do pipeline (veja Listar pipelines).
opportunity_idintegerobrigatórioO ID da oportunidade (veja Listar oportunidades).
Respostas
A oportunidade.
Ver os 15 campos
idintegerO ID da oportunidade.
contact_idintegerO ID do contato.
titlestringO nome da oportunidade.
descriptionstringA descrição.
valuenumberO valor, na moeda da conta. Não é em centavos: 1500 = R$ 1.500,00.
statusstringO estado: open (Aberto), won (Ganho; Resolvido nos pipelines de suporte e nos personalizados) ou lost (Perdido; Não Resolvido).
Valores: open won lost
prioritystringA prioridade: low (Baixa), medium (Média) ou high (Alta).
Valores: low medium high
stageobjectA etapa onde a oportunidade está.
stage.idintegerO ID da etapa.
stage.namestringO nome da etapa.
assigned_adminsarray de integerOs IDs dos administradores atribuídos.
created_atstringQuando a oportunidade foi criada, em UTC.
Exemplo: 2026-10-20 14:30:00
created_byintegerO ID do administrador que criou.
updated_atstringA última mudança, em UTC.
Exemplo: 2026-10-22 18:05:00
updated_byintegerO ID do administrador que fez a última mudança.
A chave de API não veio no cabeçalho ou não vale (foi excluída ou está incompleta). Veja Autenticação.
Relacionados
Este conteúdo ajudou?
Obrigado! Sua resposta ajuda a melhorar a central.