# Consultar pipeline

> Devolve um pipeline pelo ID: o ID e o nome.

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

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

Devolve um pipeline pelo ID: o ID e o nome. As colunas do quadro vêm em [Listar etapas do pipeline](https://docs.nextags.com.br/referencia/pipelines/listar-etapas-do-pipeline/).

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" \
  -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

O pipeline.

| Campo | Tipo | Descrição |
|---|---|---|
| `id` | integer | O ID do pipeline. |
| `name` | string | O nome do pipeline. |

```json
{
  "id": 4001,
  "name": "Funil de vendas"
}
```

### 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."
  }
}
```
