# Listar Clientes

## ListarConsumidores

<mark style="color:green;">`POST`</mark> `https://api.fidelimax.com.br/api/Integracao/ListarConsumidores`

Exemplo no POSTMAN - <https://www.postman.com/fidelimax/workspace/fidelimax-api-1-0/request/18773698-7cf7d13a-32ae-477f-9cea-538c1368c3b8>

#### Headers

| Name                                           | Type   | Description                                                                                                    |
| ---------------------------------------------- | ------ | -------------------------------------------------------------------------------------------------------------- |
| AuthToken<mark style="color:red;">\*</mark>    | string | Token de integração que esta na sua plataforma de controle em Integrações > API da Fidelimax > Quero Integrar. |
| Content-Type<mark style="color:red;">\*</mark> | String | application/json                                                                                               |

#### Request Body

| Name                                    | Type    | Description                                                               |
| --------------------------------------- | ------- | ------------------------------------------------------------------------- |
| novos<mark style="color:red;">\*</mark> | boolean | Retorna mais recentes consumidores cadastrados no programa de fidelidade  |
| skip <mark style="color:red;">\*</mark> | integer | Quantidade de registros para pular                                        |
| take<mark style="color:red;">\*</mark>  | integer | Quantidade de registros para retornar, quantidade máxima são 50 registros |

{% tabs %}
{% tab title="200 total - Quantidade total de consumidores cadastrados no programa de fidelidadeCodigoResposta - Identificação numérica da respostaMensagemErro - Mensagem retornada pela API, quando há uma resposta diferente de OKconsumidores - Array de objetos contendo as informações dos consumidoresconsumidores.nome - Nome do consumidorconsumidores.sexo - Sexo do consumidorconsumidores.data\_nascimento - Data de nascimento do consumidorconsumidores.email - E-mail do consumidorconsumidores.telefone - Telefone do consumidorconsumidores.pontuacoes - Array de objetos contendo o saldo dos consumidores por franquia/lojaconsumidores.pontuacoes.saldo - Saldo do consumidor na lojaconsumidores.pontuacoes.loja - Nome da loja " %}

```
{    
    "total": 1,
    "consumidores": [
    {
      "nome": "Nome Consumidor",
      "sexo": "Masculino",
      "data_nascimento": "26/01/1999",
      "email": "email@dominio.com.br",
      "pontuacoes" : [
        {
          "saldo": 20,
          "loja": "Loja 1" ,
          "cashback": 1     
        },
        {
          "saldo": 5,
          "loja": "Loja 2",
          "cashback": 2
        }
      ],
    },
    ],
    "CodigoResposta": 100,
    "MensagemErro": ""
}
```

{% endtab %}
{% endtabs %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.fidelimax.com.br/clientes/consultar/listar-clientes.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.