# Lista os bairros de uma cidade

Retorna os bairros de uma cidade.

Endpoint: GET /api/v3/settings/districts
Version: 3.0.0
Security: OAuth2

## Header parameters:

  - `CPlug-Company-Id` (number, required)
    Id da Empresa (Company).

Você pode localizar os IDs das empresas no _endpoint_ de listagem de empresas.
    Example: 12

## Query parameters:

  - `ibge_code` (string, required)
    Filtra pelo código do IBGE.
    Example: "3550308"

  - `name` (string)
    Filtra pelo nome do bairro.
    Example: "Centro"

  - `type_filter` (string)
    Filtra pelo tipo de bairro.
    Enum: "all", "exclude_custom", "only_custom"

  - `page` (number)
    Indica a página da paginação.

  - `per_page` (number)
    Indica a quantidade de itens por página.

## Response 200 fields (application/json):

  - `data` (object)

  - `data.custom_id` (integer)
    Identificador único do bairro customizado
    Example: 1

  - `data.name` (string)
    Nome do bairro
    Example: "Centro"

  - `data.is_global` (boolean)
    Se o bairro é compartilhado com todas as empresas
    Example: true

## Response 400 fields (application/json):

  - `code` (string, required)
    Código de erro.
    Example: "missing_headers"

  - `message` (string)
    Descrição do erro.
    Example: "error message"

  - `meta` (array)
    Dados adicionais sobre o erro.


## Response 401 fields

## Response 404 fields