Pular para o conteúdo
Acessar conta

Listar oportunidades

GET/pipelines/{pipeline_id}/opportunities
Gerada do contrato OpenAPI

Lista 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.

Requisição
curl "https://app.nextagsai.com.br/api/pipelines/4001/opportunities?contact_id=123456789" \
  -H "X-ACCESS-TOKEN: $NEXTAGS_API_KEY"

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ório

O ID do pipeline (veja Listar pipelines).

Parâmetros de consulta

contact_idnumber

O ID de um contato: traz só as oportunidades dele.

Exemplo: 123456789

offsetinteger

Quantos registros pular antes do primeiro da página. Comece em 0 e some o limit a cada página.

Padrão: 0

limitinteger

Quantos registros trazer por página.

Padrão: 100

Respostas

200Sucesso

As oportunidades, em data.

Ver os 16 campos
dataarray de objeto Oportunidade

A lista de oportunidades.

data[].idinteger

O ID da oportunidade.

data[].contact_idinteger

O ID do contato.

data[].titlestring

O nome da oportunidade.

data[].descriptionstring

A descrição.

data[].valuenumber

O valor, na moeda da conta. Não é em centavos: 1500 = R$ 1.500,00.

data[].statusstring

O estado: open (Aberto), won (Ganho; Resolvido nos pipelines de suporte e nos personalizados) ou lost (Perdido; Não Resolvido).

Valores: open won lost

data[].prioritystring

A prioridade: low (Baixa), medium (Média) ou high (Alta).

Valores: low medium high

data[].stageobject

A etapa onde a oportunidade está.

data[].stage.idinteger

O ID da etapa.

data[].stage.namestring

O nome da etapa.

data[].assigned_adminsarray de integer

Os IDs dos administradores atribuídos.

data[].created_atstring

Quando a oportunidade foi criada, em UTC.

Exemplo: 2026-10-20 14:30:00

data[].created_byinteger

O ID do administrador que criou.

data[].updated_atstring

A última mudança, em UTC.

Exemplo: 2026-10-22 18:05:00

data[].updated_byinteger

O ID do administrador que fez a última mudança.

401Chave inválida

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.