> 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/paises/list.md).

# List

## Lista de Países

## Fornece uma Lista de todos os Países existentes.

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

#### 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>                                                                            |
| country\_name | string  | <p>Nome do País. </p><p></p><p>Para pesquisa parcial pode usar o formato: "country\_name\_\_search"</p>                                                                                                               |
| code          | string  | <p>Código do País</p><p></p><p>Para pesquisa parcial pode usar o formato: "code\_\_search"</p>                                                                                                                        |
| search\_order | integer | Ordem de Pesquisa                                                                                                                                                                                                     |

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

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

{% endtab %}

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

```json
{
    "limit": 10,
    "offset": 0,
    "count": 39,
    "next": "https://api.cloudinvoice.net/countries/?limit=10&offset=10",
    "previous": null,
    "results": [
    {
            "id": 1,
            "code": "PT",
            "country_name": "Portugal",
            "is_eu": true,
            "search_order": 1
        },
        {
            "id": 2,
            "code": "ES",
            "country_name": "Espanha",
            "is_eu": true,
            "search_order": 2
        },
        ...
    ]
}
```

{% endtab %}
{% endtabs %}

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

{% hint style="info" %}
**Notas:** Alguns dos campos do termo de pesquisa geral poderão ser incluídos mediante critérios específicos (Ex: Descrição será incluída na pesquisa geral apenas se o termo de pesquisa contiver 3 ou mais caracteres). Por defeito, o comportamento expectável será obter-se todos os items cujo o texto a pesquisar (search) esteja CONTIDO em pelo menos um dos campos incluídos na pesquisa geral.
{% endhint %}