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

# List

Fornece uma lista de todos os clientes existentes.

## Listar Clientes

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

#### Query Parameters

<table data-search="false"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td>limit</td><td>integer</td><td>Define o número de registos por pesquisa.</td></tr><tr><td>offset</td><td>integer</td><td><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></td></tr><tr><td>ordering</td><td>string<br><sub><mark style="color:$info;">Default: "code"</mark></sub></td><td><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>external_code</code>, <code>fiscal_number</code>, <code>customer_name</code></li></ul><p>Use '-' antes do nome para ordem decrescente.</p></td></tr><tr><td>search</td><td>string</td><td><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>external_code</code>, <code>customer_name</code>, <code>commercial_name</code>, <code>fiscal_number</code>, etc.</li></ul></td></tr><tr><td>code</td><td>integer</td><td>Código do Cliente</td></tr><tr><td>customer_name</td><td>string</td><td><p>Nome do Cliente</p><p></p><p>Sufixos disponíveis:</p><ul><li><code>__search</code>: para pesquisa parcial</li></ul></td></tr><tr><td>commercial_name</td><td>string</td><td><p>Nome do Cliente</p><p></p><p>Sufixos disponíveis:</p><ul><li><code>__search</code>: para pesquisa parcial</li></ul></td></tr><tr><td>fiscal_number</td><td>String</td><td><p>Nº de Contribuinte</p><p></p><p>Sufixos disponíveis:</p><ul><li><code>__search</code>: para pesquisa parcial</li></ul></td></tr><tr><td>external_code</td><td>string</td><td>Código Alternativo do Cliente</td></tr></tbody></table>

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

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

{% endtab %}

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

```json
{
    "limit": 10,
    "offset": 0,
    "count": 120,
    "next": "https://api.cloudinvoice.net/customers/?limit=10&offset=10",
    "previous": null,
    "results":[
        {
            "id": 1,
            "code": 1,
            "external_code": "",
            "customer_name": "Consumidor Final",
            "commercial_name": "",
            "fiscal_number": "999999990",
            "street1": "",
            "street2": "",
            "zip_code": "",
            "zip_locale": "",
            "phone1": "",
            "mobile1": "",
            "email1": "",
            "total_debits": 168997.96,
            "total_credits": 135722.87,
            "current_balance": 33275.09,
            "fiscal_country_id": 1,
            "fiscal_country":{"code": "PT", "country_name": "Portugal"},
            "fiscal_status_type_id": 1592,
            "country_id": 1,
            "country":{"code": "PT", "country_name": "Portugal"},
            "fiscal_status_type":{"code": "1", "description": "Consumidor final"}
        },
        ...
    ]
}
```

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