GET
/
admin
/
users
/
getUserInformation
Consulta de alunos por email ou CPF
curl --request GET \
  --url https://kong.api.toolzz.com.br/admin/users/getUserInformation \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "id": 123,
    "uuid": "<string>",
    "name": "<string>",
    "email": "<string>",
    "cpf": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>",
    "ultima_atividade": "<string>",
    "school": {
      "id": 123,
      "titulo": "<string>"
    },
    "address": {
      "id": 123,
      "address_id": 123,
      "cep": "<string>",
      "uf": "<string>",
      "cidade": "<string>",
      "bairro": "<string>",
      "logradouro": "<string>",
      "numero": "<string>",
      "complemento": "<string>"
    },
    "custom_form": [
      {
        "enunciado": "<string>",
        "pergunta_id": 123,
        "resposta": "<string>"
      }
    ],
    "institution": [
      {
        "id": 123,
        "subdomain": "<string>",
        "titulo": "<string>"
      }
    ]
  }
}

​
Parâmetros

​
by
string
required
São dois valores possíveis: “email” ou “cpf”, que o sistema utilizará para buscar o usuário.
​
value
string
required
Email ou CPF do usuário desejado, de acordo com o valor definido em “by”.
Antes de utilizar este endpoint, certifique-se de possuir os seguintes parâmetros disponíveis:
  • 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.
​
data
object
Detalhes do perfil do usuário.

​
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.