> 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

## Lista de Sub-Famílias

## Fornece uma Lista de todas as Sub-Famílias existentes.

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

#### Query Parameters

| Name        | Type    | Description                                                                                                                                                                                       |
| ----------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| limit       | integer | Define o número de sub-famílias por pesquisa.                                                                                                                                                     |
| offset      | integer | Indica a posição inicial da pesquisa. Retorna a lista de sub-famílias compreendida entre offset:offset+limit.                                                                                     |
| ordering    | string  | Define o campo e a direcção a usar na pesquisa de sub-famílias. Campos ordenáveis: id, code, description, family\_id. Para ordenar de forma descendente, deve usar o sinal de '-' antes do campo. |
| search      | string  | Define o termo de pesquisa a utilizar na lista de sub-famílias. Campos Pesquisados: Código, Descrição                                                                                             |
| code        | string  | Código da Sub-Família Para pesquisa parcial pode usar o formato: "code\_\_search"                                                                                                                 |
| description | string  | Descrição Para pesquisa parcial pode usar o formato: "description\_\_search"                                                                                                                      |
| family      | integer | ID da Família                                                                                                                                                                                     |

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

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