Consulta de alunos por email ou CPF
curl --request GET \
--url https://kong.api.toolzz.com.br/admin/users/getUserInformationimport requests
url = "https://kong.api.toolzz.com.br/admin/users/getUserInformation"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://kong.api.toolzz.com.br/admin/users/getUserInformation', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://kong.api.toolzz.com.br/admin/users/getUserInformation",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://kong.api.toolzz.com.br/admin/users/getUserInformation"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://kong.api.toolzz.com.br/admin/users/getUserInformation")
.asString();require 'uri'
require 'net/http'
url = URI("https://kong.api.toolzz.com.br/admin/users/getUserInformation")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"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>"
}
]
}
}Usuarios
Consulta de alunos por email ou CPF
Consulte os dados do aluno registrado na sua instituição
GET
/
admin
/
users
/
getUserInformation
Consulta de alunos por email ou CPF
curl --request GET \
--url https://kong.api.toolzz.com.br/admin/users/getUserInformationimport requests
url = "https://kong.api.toolzz.com.br/admin/users/getUserInformation"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://kong.api.toolzz.com.br/admin/users/getUserInformation', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://kong.api.toolzz.com.br/admin/users/getUserInformation",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://kong.api.toolzz.com.br/admin/users/getUserInformation"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://kong.api.toolzz.com.br/admin/users/getUserInformation")
.asString();require 'uri'
require 'net/http'
url = URI("https://kong.api.toolzz.com.br/admin/users/getUserInformation")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"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
string
required
São dois valores possíveis: “email” ou “cpf”, que o sistema utilizará para buscar o usuário.
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.object
Detalhes do perfil do usuário.
Show properties
Show properties
number
Identificador único do usuário.
string
Identificador Universal Único (UUID) do usuário.
string
Nome completo do usuário.
string
Endereço de e-mail do usuário.
string
CPF (Cadastro de Pessoa Física) do usuário.
string
Data e hora de criação do usuário.
string
Data e hora da última atualização do perfil.
string
Data e hora da última atividade do usuário.
object
object
Detalhes do endereço do usuário.
Show properties
Show properties
array