# Users

{% tabs %}
{% tab title="Genders" %}
M - Masculino

F - Feminino

A - Outro
{% endtab %}

{% tab title="Dates" %}
O formato utilizado para a busca por data é : `YYYY-MM-DD`

**Exemplo de requisições de Data:**

De 12/07/2023 até 12/07/2023:

registerDate`[0] = "2023-07-12"`

registerDate`[1] = "2023-07-12"`
{% endtab %}
{% endtabs %}

## Busca de usuários

<mark style="color:blue;">`GET`</mark> `https://api.beepayapp.com.br/api/users`

#### Query Parameters

| Name             | Type    | Description                                                          |
| ---------------- | ------- | -------------------------------------------------------------------- |
| cpf              | String  |                                                                      |
| cep              | String  |                                                                      |
| gender           | String  | Possiveis valores definidos acima                                    |
| registerDate\[0] | String  |                                                                      |
| birthdate\[0]    | String  |                                                                      |
| blacklist        | Boolean |                                                                      |
| birthdate\[1]    | String  |                                                                      |
| registerDate\[1] | String  |                                                                      |
| id               | integer | Apenas os usuários vinculados a rede do mercado que serão retornados |

{% tabs %}
{% tab title="200: OK " %}

```json
{
    "data": [
        {
            "id": integer,
            "name": string,
            "cpf": string,
            "birthdate": string,
            "gender": integer,
            "registerDate": string,
            "email": string,
            "phone": string,
            "zipcode": string,
            "balance": float,
            "blacklist": boolean,
            "pdvs": [
                "data": [
                    "id": integer
                    "name": string
                ]
            ],
            "address": [
                 "neighborhood": string,
                 "state": string,
                 "address": string,
                 "number": string,
                 "complement": string,
                 "city": string
            ]
        }
    ],
    "links": {
        "self": "link-value",
        "first": "https://api.beepayapp.com.br/api/users?page=1",
        "last": "https://api.beepayapp.com.br/api/users?page=5",
        "prev": null,
        "next": "https://api.beepayapp.com.br/api/users?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 5,
        "path": "https://api.beepayapp.com.br/api/users",
        "per_page": 30,
        "to": 30,
        "total": 131
    }
}

```

{% endtab %}

{% tab title="422: Unprocessable Entity " %}

```json
{
    "message": "The given data was invalid.",
    "errors": {
        "campo": [
            "MENSAGEM DE ERRO"
        ]
    }
}
```

{% endtab %}
{% endtabs %}
