Listar Unidades
curl --request GET \
--url https://trialprod.app.toolzz.com.br/api/v1/schoolsimport requests
url = "https://trialprod.app.toolzz.com.br/api/v1/schools"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://trialprod.app.toolzz.com.br/api/v1/schools', 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://trialprod.app.toolzz.com.br/api/v1/schools",
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://trialprod.app.toolzz.com.br/api/v1/schools"
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://trialprod.app.toolzz.com.br/api/v1/schools")
.asString();require 'uri'
require 'net/http'
url = URI("https://trialprod.app.toolzz.com.br/api/v1/schools")
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,
"name": "<string>",
"urlSlug": "<string>",
"contractNumber": "<string>",
"tags": [
{}
],
"taxId": "<string>",
"group": [
{
"id": 123,
"name": "<string>"
}
],
"subgroups": [
{}
],
"specialties": [
{}
],
"colorScheme": {
"primary": "<string>",
"secondary": "<string>",
"buttonText": "<string>"
},
"social": {},
"location": {
"street": "<string>",
"number": "<string>",
"additionalDetails": "<string>",
"district": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>"
},
"features": {
"enableTeacherRegistration": true,
"enableStudentRegistration": true,
"enableGoogleLogin": true,
"enableLoginByDocument": true,
"enableLoginByEmail": true,
"enableForum": true,
"enableViewCounter": true,
"enableRating": true,
"isPartOfProgram": true,
"enableReviews": true,
"showSchoolIconInMenu": true,
"showIconDetails": true,
"replicateInstitutionMenuLinks": true,
"displaySchoolAccessButton": true
},
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"meta": {
"total": 123,
"per_page": "<string>",
"current_page": 123,
"last_page": 123,
"first_page_url": "<string>",
"last_page_url": "<string>",
"next_page_url": "<string>",
"prev_page_url": "<string>",
"from": 123,
"to": 123
}
}Unidades
Listar Unidades
Liste as unidades da sua instituição, com todos os seus dados e configurações. Realize uma busca específica pelo nome, número do contrato ou slug da unidade.
GET
/
api
/
v1
/
schools
Listar Unidades
curl --request GET \
--url https://trialprod.app.toolzz.com.br/api/v1/schoolsimport requests
url = "https://trialprod.app.toolzz.com.br/api/v1/schools"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://trialprod.app.toolzz.com.br/api/v1/schools', 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://trialprod.app.toolzz.com.br/api/v1/schools",
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://trialprod.app.toolzz.com.br/api/v1/schools"
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://trialprod.app.toolzz.com.br/api/v1/schools")
.asString();require 'uri'
require 'net/http'
url = URI("https://trialprod.app.toolzz.com.br/api/v1/schools")
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,
"name": "<string>",
"urlSlug": "<string>",
"contractNumber": "<string>",
"tags": [
{}
],
"taxId": "<string>",
"group": [
{
"id": 123,
"name": "<string>"
}
],
"subgroups": [
{}
],
"specialties": [
{}
],
"colorScheme": {
"primary": "<string>",
"secondary": "<string>",
"buttonText": "<string>"
},
"social": {},
"location": {
"street": "<string>",
"number": "<string>",
"additionalDetails": "<string>",
"district": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>"
},
"features": {
"enableTeacherRegistration": true,
"enableStudentRegistration": true,
"enableGoogleLogin": true,
"enableLoginByDocument": true,
"enableLoginByEmail": true,
"enableForum": true,
"enableViewCounter": true,
"enableRating": true,
"isPartOfProgram": true,
"enableReviews": true,
"showSchoolIconInMenu": true,
"showIconDetails": true,
"replicateInstitutionMenuLinks": true,
"displaySchoolAccessButton": true
},
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"meta": {
"total": 123,
"per_page": "<string>",
"current_page": 123,
"last_page": 123,
"first_page_url": "<string>",
"last_page_url": "<string>",
"next_page_url": "<string>",
"prev_page_url": "<string>",
"from": 123,
"to": 123
}
}Parâmetros
string
Listar unidade pelo nome.
string
Listar unidade pelo número do contrato.
string
Listar unidade pelo slug da URL.
string
Número da página de registros de unidades a ser exibida.
string
Número de registros a serem exibidos por página. O valor máximo permitido é 100 registros.
Este endpoint funcionará corretamente apenas se o domínio da sua instituição for informado manualmente na URL, caso contrário, o endpoint poderá falhar ou retornar um erro de validação.
Antes de utilizar este endpoint, certifique-se de possuir as seguintes informações disponíveis:
- Nome da unidade: Necessário caso a busca seja realizada pelo nome.
- Slug da URL: Necessário caso a busca seja realizada pelo slug.
- Número do contrato: Necessário caso a busca seja realizada pelo número do contrato da unidade.
Descrição da Resposta
Abaixo está um exemplo da resposta retornada por este endpoint.array
Lista das unidades educacionais.
Show items
Show items
number
Identificador único da unidade.
string
Nome da unidade.
string
Slug da URL da unidade.
string
Número do contrato associado à unidade.
array
Lista de tags associadas à unidade.
string
Número de identificação fiscal (pode ser nulo).
array
array
Lista de subgrupos associados à unidade (vazio se não houver).
array
Lista de especialidades associadas à unidade (vazio se não houver).
object
object
Informações de redes sociais (pode ser nulo).
object
object
Funcionalidades habilitadas para a unidade.
Show properties
Show properties
boolean
Indica se o cadastro de professores está habilitado.
boolean
Indica se o cadastro de alunos está habilitado.
boolean
Indica se o login via Google está habilitado.
boolean
Indica se o login via documento está habilitado.
boolean
Indica se o login via e-mail está habilitado.
boolean
Indica se o fórum está habilitado.
boolean
Indica se o contador de visualizações está habilitado.
boolean
Indica se a avaliação está habilitada.
boolean
Indica se a unidade faz parte de um programa.
boolean
Indica se as avaliações estão habilitadas.
boolean
Indica se o ícone da escola é exibido no menu.
boolean
Indica se os detalhes do ícone são exibidos.
boolean
Indica se os links do menu da instituição são replicados.
boolean
Indica se o botão de acesso à escola é exibido.
string
Data e hora da criação da unidade.
string
Data e hora da última atualização da unidade.
object
Metadados de paginação.
Show properties
Show properties
number
Número total de registros.
string
Quantidade de registros por página.
number
Número da página atual.
number
Número da última página.
string
URL da primeira página.
string
URL da última página.
string
URL da próxima página (pode ser nula).
string
URL da página anterior (pode ser nula).
number
Número do primeiro registro da página atual.
number
Número do último registro da página atual.
Antes de utilizar este endpoint, certifique-se de possuir as seguintes informações disponíveis:
- Nome da unidade: Necessário caso a busca seja realizada pelo nome.
- Slug da URL: Necessário caso a busca seja realizada pelo slug.
- Número do contrato: Necessário caso a busca seja realizada pelo número do contrato da unidade.
Segurança
Para acessar este endpoint, é necessário enviar um token de acesso válido no 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.