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

# Consulta de alunos por email ou CPF

> Consulte os dados do aluno registrado na sua instituição

## Parâmetros

<ParamField query="by" type="string" required>
  São dois valores possíveis: "email" ou "cpf", que o sistema utilizará para buscar o usuário.
</ParamField>

<ParamField query="value" type="string" required>
  Email ou CPF do usuário desejado, de acordo com o valor definido em "by".
</ParamField>

<Note> Antes de utilizar este endpoint, certifique-se de possuir os seguintes parâmetros disponíveis:</Note>

* **by `obrigatório`:** Tipo de busca, podendo ser 'email' ou 'cpf'.
* **value `obrigatório`:** Valor a ser buscado, dependendo do tipo de busca escolhido.

## Descrição da Resposta

Abaixo está um exemplo da resposta retornada por este endpoint.

<ResponseField name="data" type="object">
  Detalhes do perfil do usuário.

  <Expandable title="properties">
    <ResponseField name="id" type="number">
      Identificador único do usuário.
    </ResponseField>

    <ResponseField name="uuid" type="string">
      Identificador Universal Único (UUID) do usuário.
    </ResponseField>

    <ResponseField name="name" type="string">
      Nome completo do usuário.
    </ResponseField>

    <ResponseField name="email" type="string">
      Endereço de e-mail do usuário.
    </ResponseField>

    <ResponseField name="cpf" type="string">
      CPF (Cadastro de Pessoa Física) do usuário.
    </ResponseField>

    <ResponseField name="created_at" type="string">
      Data e hora de criação do usuário.
    </ResponseField>

    <ResponseField name="updated_at" type="string">
      Data e hora da última atualização do perfil.
    </ResponseField>

    <ResponseField name="ultima_atividade" type="string">
      Data e hora da última atividade do usuário.
    </ResponseField>

    <ResponseField name="school" type="object">
      Informações da escola.

      <Expandable title="properties">
        <ResponseField name="id" type="number">
          Identificador único da escola.
        </ResponseField>

        <ResponseField name="titulo" type="string">
          Nome da escola.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="address" type="object">
      Detalhes do endereço do usuário.

      <Expandable title="properties">
        <ResponseField name="id" type="number">
          Identificador único do endereço.
        </ResponseField>

        <ResponseField name="address_id" type="number">
          ID de referência do endereço.
        </ResponseField>

        <ResponseField name="cep" type="string">
          Código Postal (CEP).
        </ResponseField>

        <ResponseField name="uf" type="string">
          Sigla do estado.
        </ResponseField>

        <ResponseField name="cidade" type="string">
          Nome da cidade.
        </ResponseField>

        <ResponseField name="bairro" type="string">
          Nome do bairro.
        </ResponseField>

        <ResponseField name="logradouro" type="string">
          Nome da rua.
        </ResponseField>

        <ResponseField name="numero" type="string">
          Número da residência ou apartamento.
        </ResponseField>

        <ResponseField name="complemento" type="string">
          Complemento do endereço (ex: apartamento, andar).
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="custom_form" type="array">
      Lista de perguntas e respostas personalizadas.

      <Expandable title="items">
        <ResponseField name="enunciado" type="string">
          Enunciado da pergunta.
        </ResponseField>

        <ResponseField name="pergunta_id" type="number">
          Identificador único da pergunta.
        </ResponseField>

        <ResponseField name="resposta" type="string">
          Resposta do usuário à pergunta.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="institution" type="array">
      Lista de instituições associadas ao usuário.

      <Expandable title="items">
        <ResponseField name="id" type="number">
          Identificador único da instituição.
        </ResponseField>

        <ResponseField name="subdomain" type="string">
          Subdomínio da instituição.
        </ResponseField>

        <ResponseField name="titulo" type="string">
          Nome da instituição.
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

## Segurança

Para acessar este endpoint, é necessário enviar um token de acesso válido por meio do cabeçalho de autorização (Authorization) da requisição.
Além disso, a API é protegida por outras medidas de segurança para garantir a proteção dos dados dos usuários.