# Listar pipelines

> Lista os pipelines da conta, com o ID e o nome de cada um.

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

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

Lista os pipelines da conta, com o ID e o nome de cada um. É daqui que sai o `pipeline_id` das outras chamadas. A lista vem em páginas: ande por ela com `offset` e `limit`.

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 consulta

| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| `offset` | integer | não | Quantos registros pular antes do primeiro da página. Comece em 0 e some o `limit` a cada página. Padrão: `0`. |
| `limit` | integer | não | Quantos registros trazer por página. Padrão: `100`. |

## Exemplo

```bash
curl "https://app.nextagsai.com.br/api/pipelines" \
  -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

Os pipelines, em `data`.

| Campo | Tipo | Descrição |
|---|---|---|
| `data` | array de objeto Pipeline | A lista de pipelines. |
| `data[].id` | integer | O ID do pipeline. |
| `data[].name` | string | O nome do pipeline. |

```json
{
  "data": [
    {
      "id": 4001,
      "name": "Funil de vendas"
    },
    {
      "id": 4002,
      "name": "Onboarding de clientes"
    }
  ]
}
```

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