# Informações da raiz da API

`GET /`

Pasta: **Sistema**

## Autenticação

Nenhuma (rota pública) ou herda auth da collection.

## Descrição

# Informações da raiz da API

Retorna metadados básicos do serviço e os caminhos dos endpoints de health. Use para descobrir rapidamente se a base URL aponta para a GoZap API.

## Endpoint

`GET {{baseUrl}}/`

## Autenticação

Não requer autenticação.

## Exemplo de Requisição

```bash
curl --request GET '{{baseUrl}}/'
```

## Resposta de Sucesso

```json
{
  "name": "GoZap API",
  "status": "ok",
  "client_name": "develop",
  "health": "/health",
  "health_overview": "/health/overview"
}
```

## Erros comuns

- Sem resposta / timeout: a base URL está incorreta ou o serviço está offline.
- JSON inesperado: você pode estar apontando para outro serviço na mesma URL.

## cURL

```bash
curl -X GET "{{baseUrl}}/"
```

---

[Índice da pasta](./index.md) · [Índice geral](../index.md) · [UI](https://gozap.dev/docs?op=sistema/informacoes-da-raiz-da-api)