# Consultar campo do bot

> Devolve o nome, o tipo e o valor de um campo do bot.

Endereço: https://docs.nextags.com.br/referencia/campos-do-bot/consultar-campo-do-bot/
Tipo: Endpoint

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

Devolve o nome, o tipo e o valor de um campo do bot.

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 |
|---|---|---|---|
| `bot_field_id` | integer | sim | O ID do campo do bot. |

## Exemplo

```bash
curl "https://app.nextagsai.com.br/api/accounts/bot_fields/3101" \
  -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 campo do bot, com o valor.

| Campo | Tipo | Descrição |
|---|---|---|
| `id` | integer | O ID do campo do bot. |
| `type` | integer | O tipo: 0 texto, 1 número, 2 data, 3 data e hora, 4 sim/não, 5 texto longo. |
| `name` | string | O nome do campo. |
| `value` | string ou number | O valor, no formato do tipo: texto nos campos de texto e de texto longo; número nos de número, de data e de data e hora (Unix timestamp, em segundos) e de sim/não (1 ou 0). |

```json
{
  "id": 3101,
  "name": "Horário de atendimento",
  "type": 0,
  "value": "Seg a sex, das 9h às 18h"
}
```

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