Listar campos do pipeline

GET/pipelines/{pipeline_id}/custom_fields

Gerada do contrato OpenAPI

Lista os campos do pipeline: os campos próprios das oportunidades, criados nas definições do pipeline em Campo Personalizados. Não são os campos personalizados do contato. Use o id ou o name deles em custom_fields, ao criar ou atualizar uma oportunidade. Veja Comentários, anexos e campos do pipeline.

Requisição

curl "https://app.nextagsai.com.br/api/pipelines/4001/custom_fields" \
  -H "X-ACCESS-TOKEN: $NEXTAGS_API_KEY"

const resposta = await fetch('https://app.nextagsai.com.br/api/pipelines/4001/custom_fields', {
  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/custom_fields",
    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/custom_fields');
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ório

O ID do pipeline (veja Listar pipelines).

Respostas

200Sucessolista de object

A lista de campos, sem data em volta.

idinteger

O ID do campo.

namestring

O Nome do campo, como aparece na oportunidade.

typeinteger ou string

O código do tipo, como na tela: 0 Texto, 1 Número, 2 Data, 3 Data e hora, 4 Verdadeiro/Falso, 6 Seleção única e 7 Seleção múltipla.

descriptionstring

A descrição do campo. A tela não pede descrição ao criar o campo.

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.

const resposta = await fetch('https://app.nextagsai.com.br/api/pipelines/4001/custom_fields', { 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/custom_fields", 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/custom_fields'); 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

Parâmetros de caminho

Respostas

Relacionados

Campos personalizados, campos do bot e variáveis

Criar e mover oportunidades no pipeline

Comentários, anexos e campos do pipeline

Listar pipelines

Consultar pipeline

Listar etapas do pipeline