> 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

Fornece uma lista de todos os concelhos existentes.

## Lista de Concelhos

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

#### Query Parameters

| Name        | Type                                                                                 | Description                                                                                                                                                                                                                                                 |
| ----------- | ------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| limit       | integer                                                                              | Define o número de registos por pesquisa.                                                                                                                                                                                                                   |
| offset      | integer                                                                              | <p>Indica a posição inicial da pesquisa.</p><p>Retorna a lista de registos compreendida entre <code>offset</code> e <code>offset+limit</code>.</p>                                                                                                          |
| ordering    | <p>string<br><sub><mark style="color:$info;">Default: "description"</mark></sub></p> | <p>Define o campo e a direção a usar na pesquisa de registos. </p><p></p><p>Campos ordenáveis:</p><ul><li><code>id</code>, <code>code</code>, <code>description</code>, <code>district</code></li></ul><p>Use '-' antes do nome para ordem decrescente.</p> |
| search      | string                                                                               | <p>Define o termo de pesquisa a utilizar na lista de registos. </p><p></p><p>Campos Pesquisados:</p><ul><li><code>code</code>, <code>description</code>, <code>district</code></li></ul>                                                                    |
| code        | string                                                                               | <p>Código</p><p></p><p>Sufixos disponíveis:</p><ul><li><code>\_\_search</code>: para pesquisa parcial</li></ul>                                                                                                                                             |
| description | string                                                                               | <p>Descrição</p><p></p><p>Sufixos disponíveis:</p><ul><li><code>\_\_search</code>: para pesquisa parcial</li></ul>                                                                                                                                          |

{% 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)