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

# Obter Instituição

> Endpoint para obter uma instituição pelo id

## Token de Acesso

<ParamField header="Authorization" type="string">
  Token de acesso ("Bearer" deve estar antes do token)
</ParamField>

### Parâmetros

<ParamField path="id" type="string">
  ID da instituição
</ParamField>

### Descrição da Resposta

O endpoint retorna uma resposta em formato JSON com a confirmação da solicitação.

<ResponseField name="id" type="string">
  Identificador único (opcional).
</ResponseField>

<ResponseField name="institutionToolzzId" type="number" required>
  ID da instituição no sistema Toolzz.
</ResponseField>

<ResponseField name="aiDefaultModel" type="string" required>
  Modelo de IA padrão utilizado pela instituição.
</ResponseField>

<ResponseField name="chatStyle" type="string" required>
  Configuração de estilo da interface do chat.
</ResponseField>

<ResponseField name="primaryColorHex" type="string" required>
  Cor primária em formato HEX.
</ResponseField>

<ResponseField name="secondaryColorHex" type="string" required>
  Cor secundária em formato HEX.
</ResponseField>

<ResponseField name="lightModeLogoUrl" type="string" required>
  URL do logo para o modo claro.
</ResponseField>

<ResponseField name="lightModeAltLogoUrl" type="string">
  URL do logo alternativo para o modo claro (opcional).
</ResponseField>

<ResponseField name="darkModeLogoUrl" type="string" required>
  URL do logo para o modo escuro.
</ResponseField>

<ResponseField name="darkModeAltLogoUrl" type="string">
  URL do logo alternativo para o modo escuro (opcional).
</ResponseField>

<ResponseField name="faviconUrl" type="string" required>
  URL do favicon.
</ResponseField>

<ResponseField name="theme" type="string" required>
  Configuração de tema do sistema.
</ResponseField>

<ResponseField name="subdomain" type="string" required>
  Subdomínio associado à instituição.
</ResponseField>

<ResponseField name="customDomain" type="string">
  Domínio personalizado associado à instituição (opcional).
</ResponseField>

<ResponseField name="apiConversationUrl" type="string">
  URL do endpoint de conversação da API (opcional).
</ResponseField>

<ResponseField name="userId" type="uuid" required>
  Identificador do usuário associado.
</ResponseField>

<ResponseField name="cnpj" type="string" required>
  CNPJ (Cadastro Nacional da Pessoa Jurídica) da instituição.
</ResponseField>

<ResponseField name="isActive" type="boolean" required>
  Indica se a instituição está ativa.
</ResponseField>

<ResponseField name="name" type="string" required>
  Nome da instituição.
</ResponseField>

<ResponseField name="description" type="string" required>
  Descrição da instituição.
</ResponseField>

<ResponseField name="safetyPlan" type="string" required>
  Plano de segurança associado à instituição.
</ResponseField>

<ResponseField name="adminId" type="uuid" required>
  ID do administrador associado à instituição.
</ResponseField>

<ResponseField name="customerId" type="uuid" required>
  ID do cliente associado à instituição.
</ResponseField>

<ResponseField name="subscriptionId" type="uuid" required>
  ID do plano de assinatura da instituição.
</ResponseField>

<ResponseField name="institutionPlan" type="InstitutionPlan" required>
  Detalhes do plano da instituição.

  <Expandable title="Propriedades">
    <ResponseField name="id" type="uuid" required>
      Identificador único.
    </ResponseField>

    <ResponseField name="institutionId" type="uuid" required>
      ID da instituição associada.
    </ResponseField>

    <ResponseField name="unitiesLimit" type="number" required>
      Limite de unidades organizacionais.
    </ResponseField>

    <ResponseField name="botsLimit" type="number" required>
      Número máximo de agentes permitidos.
    </ResponseField>

    <ResponseField name="widgetsLimit" type="number" required>
      Limite de widgets.
    </ResponseField>

    <ResponseField name="knowledgeBasesLimit" type="number" required>
      Número máximo de Bases de Conhecimento permitidas.
    </ResponseField>

    <ResponseField name="pluginsLimit" type="number" required>
      Limite de plugins.
    </ResponseField>

    <ResponseField name="vectorsLimit" type="number" required>
      Número máximo de vetores permitidos.
    </ResponseField>

    <ResponseField name="createdAt" type="date-time" required>
      Data e hora de criação do registro.
    </ResponseField>

    <ResponseField name="updatedAt" type="date-time" required>
      Data e hora da última atualização do registro.
    </ResponseField>
  </Expandable>
</ResponseField>

## Segurança

Para acessar este endpoint, é necessário enviar um **token de acesso** válido através do cabeçalho de autorização (Authorization) da requisição. Além disso, a API é protegida por outras medidas de segurança para proteger os dados dos usuários.