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

# List

## Lista de Vendedores

## Fornece uma Lista de todos os vendedores existentes.

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

#### Query Parameters

| Name           | Type    | Description                                                                                                |
| -------------- | ------- | ---------------------------------------------------------------------------------------------------------- |
| limit          | integer | Define o número de vendedor por pesquisa.                                                                  |
| offset         | integer | Indica a posição inicial da pesquisa. Retorna a lista de clientes compreendida entre offset:offset+limit.  |
| ordering       | string  | Define o campo e a direcção a usar na pesquisa.                                                            |
| search         | string  | Define o termo de pesquisa a utilizar na lista.                                                            |
| code           | integer | Código do vendedor para pesquisa.                                                                          |
| salesman\_name | string  | <p>Nome do Vendedor</p><p></p><p>Para pesquisa parcial pode usar o formato: "salesman\_name\_\_search"</p> |

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

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

{% endtab %}

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

```json
{
    "limit": 10,
    "offset": 0,
    "count": 3,
    "next": "https://api.cloudinvoice.net/salesmen/?limit=10&offset=10",
    "previous": null,
    "results":[
        {
            "id": 1,
            "code": 1,
            "salesman_name": "Vendedor Demo",
            "job_title": "",
            "company_phone1": "281380900",
            "company_mobile": "",
            "company_email1": "suporte@cloudinvoice.net"
        },
        ...
    ]
}
```

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