> ## Documentation Index
> Fetch the complete documentation index at: https://docs.crescamais.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Listar usuários

> Liste os alunos da empresa e filtre o resultado por e-mail ou CPF.

Retorna os usuários com perfil de aluno da empresa associada ao token. Usuários do grupo de professor não entram no resultado.

## Parâmetros de consulta

<ParamField query="email" type="string">
  Retorna somente o usuário com o e-mail informado.
</ParamField>

<ParamField query="cpf" type="string">
  Retorna somente o usuário com o CPF informado. Use o mesmo formato armazenado na plataforma.
</ParamField>

```bash cURL theme={null}
curl "https://api.crescamais.com/integrations/analytics/users?email=joao%40empresa.com" \
  -H "Authorization: Bearer SEU_TOKEN_DE_INTEGRACAO"
```

## Resposta

```json theme={null}
{
  "users": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "João da Silva",
      "email": "joao@empresa.com",
      "active": true,
      "last_login_at": "2026-09-02T13:45:00.000Z",
      "status": "Ativo",
      "id_group": "9b9d9de5-2528-47dd-8587-9a47044b3406",
      "phone": null,
      "cellphone": "11999999999",
      "created_at": "2026-08-01T12:00:00.000Z",
      "updated_at": "2026-09-02T13:45:00.000Z",
      "cpf": "18498670039",
      "group": {
        "name": "Aluno"
      },
      "Setor": "Marketing"
    }
  ],
  "total": 1,
  "timestamp": "2026-09-03T12:00:00.000Z"
}
```

Os campos personalizados da empresa são adicionados diretamente a cada objeto de usuário. Por isso, campos como `Setor` variam entre empresas.

<ResponseField name="status" type="string">
  Retorna `Ativo` quando o status numérico armazenado é `1`. Nos demais casos, retorna `Bloqueado`.
</ResponseField>

<ResponseField name="total" type="integer">
  Quantidade de usuários encontrados.
</ResponseField>

## Erros

| Status | Causa                                  |
| ------ | -------------------------------------- |
| `401`  | Token ausente, malformado ou inválido. |
| `500`  | Erro interno durante a consulta.       |