# Buscar campo pelo nome

> Encontra um campo personalizado pelo nome e devolve o ID, o tipo e a descrição.

Endereço: https://docs.nextags.com.br/referencia/campos-personalizados/buscar-campo-pelo-nome/
Tipo: Endpoint

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

Encontra um campo personalizado pelo nome e devolve o ID, o tipo e a descrição. O nome vai no caminho, codificado para URL: `data de nascimento` vira `data%20de%20nascimento`.

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 |
|---|---|---|---|
| `custom_field_name` | string | sim | O nome do campo, codificado para URL. |

## Exemplo

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

| Campo | Tipo | Descrição |
|---|---|---|
| `id` | integer | O ID do campo. |
| `name` | string | O nome do campo. |
| `type` | integer | O tipo: 0 texto, 1 número, 2 data, 3 data e hora, 4 sim/não, 5 texto longo, 6 seleção única, 7 seleção múltipla. |
| `description` | string | A descrição do campo. |

```json
{
  "id": 3001,
  "name": "cidade",
  "type": 0,
  "description": "Cidade de entrega"
}
```

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