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

# List

Fornece uma lista de todas as sub-famílias existentes.

## Listar Sub-Famílias

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

#### 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</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>description</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>description</code></li></ul></td></tr><tr><td>code</td><td>string</td><td><p>Código da Sub-Família</p><p></p><p>Sufixos disponíveis:</p><ul><li><code>__search</code>: para pesquisa parcial</li></ul></td></tr><tr><td>description</td><td>string</td><td><p>Descrição</p><p></p><p>Sufixos disponíveis:</p><ul><li><code>__search</code>: para pesquisa parcial</li></ul></td></tr><tr><td>family</td><td>integer</td><td>ID da Família</td></tr></tbody></table>

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

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

{% endtab %}

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

```json
{
    "limit": 10,
    "offset": 0,
    "count": 47,
    "next": "https://api.cloudinvoice.net/sub_families/?limit=10&offset=10",
    "previous": null,
    "results": [
    {
        "id": 1,
        "code": "1",
        "description": "Sub-Familia 1",
        "photo_image_path": null,
        "button_background_color": 3,
        "is_disable_touch": false,
        "obs": ""
        "family_id": 1,
        "family": {
            "code": "P1",
            "description": "Famílía 1"
        }
    },
    ...
    ]
}
```

{% endtab %}
{% endtabs %}

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