Skip to main content
GET
/
api
/
v1
/
schools
Listar Unidades
curl --request GET \
  --url https://trialprod.app.toolzz.com.br/api/v1/schools \
  --header 'Authorization: Bearer <token>'
{
  "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

​
name
string
Listar unidade pelo nome.
​
contractNumber
string
Listar unidade pelo número do contrato.
​
urlSlug
string
Listar unidade pelo slug da URL.
​
page
string
Número da página de registros de unidades a ser exibida.
​
perPage
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.
​
data
array
Lista das unidades educacionais.
​
meta
object
Metadados de paginaçã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.

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