Listar oportunidades
/pipelines/{pipeline_id}/opportunitiesLista as oportunidades de um pipeline, em páginas (offset e limit). Com contact_id, traz só as de um contato: o jeito de saber se o cliente já tem uma oportunidade aberta antes de criar outra.
curl "https://app.nextagsai.com.br/api/pipelines/4001/opportunities?contact_id=123456789" \
-H "X-ACCESS-TOKEN: $NEXTAGS_API_KEY"
const resposta = await fetch(`https://app.nextagsai.com.br/api/pipelines/4001/opportunities?${new URLSearchParams({
contact_id: 123456789,
})}`, {
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",
headers={"X-ACCESS-TOKEN": os.environ["NEXTAGS_API_KEY"]},
params={
"contact_id": 123456789,
},
timeout=30,
)
print(resposta.status_code, resposta.json())
<?php
$ch = curl_init('https://app.nextagsai.com.br/api/pipelines/4001/opportunities?' . http_build_query([
'contact_id' => 123456789,
]));
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).
Parâmetros de consulta
contact_idnumberO ID de um contato: traz só as oportunidades dele.
Exemplo: 123456789
offsetintegerQuantos registros pular antes do primeiro da página. Comece em 0 e some o limit a cada página.
Padrão: 0
limitintegerQuantos registros trazer por página.
Padrão: 100
Respostas
As oportunidades, em data.
Ver os 16 campos
dataarray de objeto OportunidadeA lista de oportunidades.
data[].idintegerO ID da oportunidade.
data[].contact_idintegerO ID do contato.
data[].titlestringO nome da oportunidade.
data[].descriptionstringA descrição.
data[].valuenumberO valor, na moeda da conta. Não é em centavos: 1500 = R$ 1.500,00.
data[].statusstringO estado: open (Aberto), won (Ganho; Resolvido nos pipelines de suporte e nos personalizados) ou lost (Perdido; Não Resolvido).
Valores: open won lost
data[].prioritystringA prioridade: low (Baixa), medium (Média) ou high (Alta).
Valores: low medium high
data[].stageobjectA etapa onde a oportunidade está.
data[].stage.idintegerO ID da etapa.
data[].stage.namestringO nome da etapa.
data[].assigned_adminsarray de integerOs IDs dos administradores atribuídos.
data[].created_atstringQuando a oportunidade foi criada, em UTC.
Exemplo: 2026-10-20 14:30:00
data[].created_byintegerO ID do administrador que criou.
data[].updated_atstringA última mudança, em UTC.
Exemplo: 2026-10-22 18:05:00
data[].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
Contatos, fluxos e outros identificadores
Guia que usa este endpointLimites, erros e boas práticas
Guia que usa este endpointCriar e mover oportunidades no pipeline
Guia que usa este endpointFiltrar e ordenar o quadro
Tutorial da Central de AjudaListar pipelines
GET /pipelinesConsultar pipeline
GET /pipelines/{pipeline_id}Este conteúdo ajudou?
Obrigado! Sua resposta ajuda a melhorar a central.