> For the complete documentation index, see [llms.txt](https://apidocs.cloudinvoice.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://apidocs.cloudinvoice.net/documentacao-api/concelhos/list.md).

# List

## Lista de Concelhos

## Fornece uma Lista de todos os Concelhos existentes.

<mark style="color:blue;">`GET`</mark> `https://api.cloudinvoice.net/localities/`

#### Query Parameters

| Name        | Type    | Description                                                                                                                                                                                                           |
| ----------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| limit       | integer | Define o número de países por pesquisa.                                                                                                                                                                               |
| offset      | integer | Indica a posição inicial da pesquisa. Retorna a lista de países  compreendida entre offset:offset+limit.                                                                                                              |
| ordering    | string  | <p>Define o campo e a direcção a usar na pesquisa de países. </p><p></p><p>Campos ordenáveis: id, code, search\_order, country\_name. Para ordenar de forma descendente, deve usar o sinal de '-' antes do campo.</p> |
| search      | string  | <p>Define o termo de pesquisa a utilizar na lista de países. </p><p></p><p>Campos Pesquisados: Código, Nome do País, Ordem de Pesquisa</p>                                                                            |
| code        | string  | <p>Código do Concelho</p><p></p><p>Para pesquisa parcial pode usar o formato: "code\_\_search"</p>                                                                                                                    |
| description | string  | <p>Descrição</p><p></p><p>Para pesquisa parcial pode usar o formato: "description\_\_search"</p>                                                                                                                      |

{% tabs %}
{% tab title="Exemplo de Pedido" %}

```shell
curl https://api.cloudinvoice.net/localities/
    -H "Content-Type: application/json"
```

{% endtab %}

{% tab title="Exemplo de Resposta" %}

```json
{
    "limit": 10,
    "offset": 0,
    "count": 309,
    "next": "https://api.cloudinvoice.net/localities/?limit=10&offset=10",
    "previous": null,
    "results": [
        {
            "id": 1,
            "code": "01",
            "description": "Águeda",
            "zip_code": "375",
            "district_id": 1,
            "district": {
                "code": "01",
                "description": "Aveiro"
            }
        },
        {
            "id": 2,
            "code": "02",
            "description": "Albergaria-a-Velha",
            "zip_code": "385",
            "district_id": 1,
            "district": {
                "code": "01",
                "description": "Aveiro"
            }
        },
        ...
    ]
}
```

{% endtab %}
{% endtabs %}

Para ver exemplos de pedidos nas várias linguagens, consulte a página[ Exemplos de Pedidos.](/introducao/exemplos-de-pedidos.md)