# Lista Municípios

> Parâmetros, exemplos e respostas de GET /v1/municipios na NextAPI.

Fonte: https://www.nextapi.com.br/docs/api/get-v1-municipios

`GET /v1/municipios`

Lista todos os municípios de forma paginada, com filtro opcional por UF.

- O resultado da consulta é paginado com limite de 200 itens por pagina.
- Cada consulta consome 1 crédito.
- Disponível somente nos planos pagos.

URL base: `https://api.nextapi.com.br`. Autenticação: cabeçalho `Authorization: Bearer SEU_TOKEN`.

## Exemplo de requisição

```bash
curl --request GET 'https://api.nextapi.com.br/v1/municipios' \
  --header 'Authorization: Bearer SEU_TOKEN' \
  --header 'Accept: application/json'
```

## Parâmetros

| Nome | Local | Obrigatório | Tipo / regras | Descrição |
| --- | --- | --- | --- | --- |
| `uf` | query | Não | `string` | Sigla do estado para filtro (ex: SP, RJ) |
| `page` | query | Não | `integer (int32)` | Número da página (padrão: 1) |
| `pageSize` | query | Não | `integer (int32)` | Quantidade de itens por página (máx: 200) |

## Respostas HTTP

| Status | Descrição | Formato JSON |
| --- | --- | --- |
| `200` | Operação realizada com sucesso | MunicipioItemResponsePagedResult |
| `400` | Erro nos parametros informados na requisição | IErrorCodeModel |
| `405` | Falta de créditos para realizar a consulta | IErrorCodeModel |
| `500` | Erro ao processar a requisição | IErrorCodeModel |

Autenticação e limites também podem gerar erros antes da execução da operação. Veja o [guia de tratamento de erros](https://www.nextapi.com.br/docs/erros.md).

## Resposta de sucesso

Exemplo estrutural gerado do schema: os valores são ilustrativos. Campos anuláveis podem retornar `null`.

```json
{
  "page": 0,
  "pageSize": 0,
  "total": 0,
  "items": [
    {
      "id": 0,
      "descricao": "string",
      "uf": "string"
    }
  ]
}
```

## Campos da resposta

Modelo: `MunicipioItemResponsePagedResult`

### MunicipioItemResponsePagedResult

| Campo | Tipo | Obrigatório | Descrição / regras |
| --- | --- | --- | --- |
| `page` | `integer (int32)` | Não marcado no contrato | — |
| `pageSize` | `integer (int32)` | Não marcado no contrato | — |
| `total` | `integer (int64)` | Não marcado no contrato | — |
| `items` | `MunicipioItemResponse[]` | Não marcado no contrato | — |

### MunicipioItemResponse

| Campo | Tipo | Obrigatório | Descrição / regras |
| --- | --- | --- | --- |
| `id` | `integer (int32)` | Sim | — |
| `descricao` | `string \| null` | Sim | — |
| `uf` | `string \| null` | Sim | — |