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

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

## Parâmetros

<ParamField query="name" type="string">
  Listar unidade pelo nome.
</ParamField>

<ParamField query="contractNumber" type="string">
  Listar unidade pelo número do contrato.
</ParamField>

<ParamField query="urlSlug" type="string">
  Listar unidade pelo slug da URL.
</ParamField>

<ParamField query="page" type="string">
  Número da página de registros de unidades a ser exibida.
</ParamField>

<ParamField query="perPage" type="string">
  Número de registros a serem exibidos por página. O valor máximo permitido é 100 registros.
</ParamField>

<Warning>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.</Warning>

<Note>Antes de utilizar este endpoint, certifique-se de possuir as seguintes informações disponíveis:</Note>

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

<ResponseField name="data" type="array">
  Lista das unidades educacionais.

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

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

    <ResponseField name="urlSlug" type="string">
      Slug da URL da unidade.
    </ResponseField>

    <ResponseField name="contractNumber" type="string">
      Número do contrato associado à unidade.
    </ResponseField>

    <ResponseField name="tags" type="array">
      Lista de tags associadas à unidade.
    </ResponseField>

    <ResponseField name="taxId" type="string">
      Número de identificação fiscal (pode ser nulo).
    </ResponseField>

    <ResponseField name="group" type="array">
      Lista de grupos associados à unidade.

      <Expandable title="items">
        <ResponseField name="id" type="number">
          Identificador único do grupo.
        </ResponseField>

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

    <ResponseField name="subgroups" type="array">
      Lista de subgrupos associados à unidade (vazio se não houver).
    </ResponseField>

    <ResponseField name="specialties" type="array">
      Lista de especialidades associadas à unidade (vazio se não houver).
    </ResponseField>

    <ResponseField name="colorScheme" type="object">
      Configuração de esquema de cores.

      <Expandable title="properties">
        <ResponseField name="primary" type="string">
          Código da cor primária.
        </ResponseField>

        <ResponseField name="secondary" type="string">
          Código da cor secundária.
        </ResponseField>

        <ResponseField name="buttonText" type="string">
          Código da cor do texto dos botões.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="social" type="object">
      Informações de redes sociais (pode ser nulo).
    </ResponseField>

    <ResponseField name="location" type="object">
      Detalhes de localização da unidade.

      <Expandable title="properties">
        <ResponseField name="street" type="string">
          Nome da rua.
        </ResponseField>

        <ResponseField name="number" type="string">
          Número da rua.
        </ResponseField>

        <ResponseField name="additionalDetails" type="string">
          Detalhes adicionais sobre a localização.
        </ResponseField>

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

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

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

        <ResponseField name="zipCode" type="string">
          Código postal (CEP).
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="features" type="object">
      Funcionalidades habilitadas para a unidade.

      <Expandable title="properties">
        <ResponseField name="enableTeacherRegistration" type="boolean">
          Indica se o cadastro de professores está habilitado.
        </ResponseField>

        <ResponseField name="enableStudentRegistration" type="boolean">
          Indica se o cadastro de alunos está habilitado.
        </ResponseField>

        <ResponseField name="enableGoogleLogin" type="boolean">
          Indica se o login via Google está habilitado.
        </ResponseField>

        <ResponseField name="enableLoginByDocument" type="boolean">
          Indica se o login via documento está habilitado.
        </ResponseField>

        <ResponseField name="enableLoginByEmail" type="boolean">
          Indica se o login via e-mail está habilitado.
        </ResponseField>

        <ResponseField name="enableForum" type="boolean">
          Indica se o fórum está habilitado.
        </ResponseField>

        <ResponseField name="enableViewCounter" type="boolean">
          Indica se o contador de visualizações está habilitado.
        </ResponseField>

        <ResponseField name="enableRating" type="boolean">
          Indica se a avaliação está habilitada.
        </ResponseField>

        <ResponseField name="isPartOfProgram" type="boolean">
          Indica se a unidade faz parte de um programa.
        </ResponseField>

        <ResponseField name="enableReviews" type="boolean">
          Indica se as avaliações estão habilitadas.
        </ResponseField>

        <ResponseField name="showSchoolIconInMenu" type="boolean">
          Indica se o ícone da escola é exibido no menu.
        </ResponseField>

        <ResponseField name="showIconDetails" type="boolean">
          Indica se os detalhes do ícone são exibidos.
        </ResponseField>

        <ResponseField name="replicateInstitutionMenuLinks" type="boolean">
          Indica se os links do menu da instituição são replicados.
        </ResponseField>

        <ResponseField name="displaySchoolAccessButton" type="boolean">
          Indica se o botão de acesso à escola é exibido.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="createdAt" type="string">
      Data e hora da criação da unidade.
    </ResponseField>

    <ResponseField name="updatedAt" type="string">
      Data e hora da última atualização da unidade.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="meta" type="object">
  Metadados de paginação.

  <Expandable title="properties">
    <ResponseField name="total" type="number">
      Número total de registros.
    </ResponseField>

    <ResponseField name="per_page" type="string">
      Quantidade de registros por página.
    </ResponseField>

    <ResponseField name="current_page" type="number">
      Número da página atual.
    </ResponseField>

    <ResponseField name="last_page" type="number">
      Número da última página.
    </ResponseField>

    <ResponseField name="first_page_url" type="string">
      URL da primeira página.
    </ResponseField>

    <ResponseField name="last_page_url" type="string">
      URL da última página.
    </ResponseField>

    <ResponseField name="next_page_url" type="string">
      URL da próxima página (pode ser nula).
    </ResponseField>

    <ResponseField name="prev_page_url" type="string">
      URL da página anterior (pode ser nula).
    </ResponseField>

    <ResponseField name="from" type="number">
      Número do primeiro registro da página atual.
    </ResponseField>

    <ResponseField name="to" type="number">
      Número do último registro da página atual.
    </ResponseField>
  </Expandable>
</ResponseField>

<Note>Antes de utilizar este endpoint, certifique-se de possuir as seguintes informações disponíveis:</Note>

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