# Listar campos do pipeline

> Lista os campos do pipeline: os campos próprios das oportunidades, criados nas definições do pipeline em Campo Personalizados.

Endereço: https://docs.nextags.com.br/referencia/pipelines/listar-campos-do-pipeline/
Tipo: Endpoint

```http
GET https://app.nextagsai.com.br/api/pipelines/{pipeline_id}/custom_fields
X-ACCESS-TOKEN: <sua chave de API>
```

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](https://help.nextags.com.br/tutoriais/pipelines/comentarios-e-anexos/).

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](https://docs.nextags.com.br/comecar/autenticacao/).

## Parâmetros de caminho

| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| `pipeline_id` | integer | sim | O ID do pipeline (veja [Listar pipelines](https://docs.nextags.com.br/referencia/pipelines/listar-pipelines/)). |

## Exemplo

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

Os exemplos em JavaScript, Python e PHP estão na página e no contrato (`x-codeSamples` em https://docs.nextags.com.br/openapi.json).

## Respostas

### 200 Sucesso

A lista de campos, sem `data` em volta.

Uma lista de object.

| Campo | Tipo | Descrição |
|---|---|---|
| `id` | integer | O ID do campo. |
| `name` | string | O **Nome** do campo, como aparece na oportunidade. |
| `type` | integer 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. |
| `description` | string | A descrição do campo. A tela não pede descrição ao criar o campo. |

```json
[
  {
    "id": 3201,
    "name": "Origem do lead",
    "type": 0,
    "description": ""
  },
  {
    "id": 3202,
    "name": "Previsão de fechamento",
    "type": 2,
    "description": ""
  }
]
```

### 401 Chave 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](https://docs.nextags.com.br/comecar/autenticacao/).

```json
{
  "error": {
    "code": 401,
    "message": "No valid API key provided."
  }
}
```