GET
/
api
/
v1
/
institution
/
id
/
{id}
Obter Instituição
curl --request GET \
  --url https://chat.api.toolzz.com.br/api/v1/institution/id/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "institutionToolzzId": 123,
  "aiDefaultModel": "<string>",
  "chatStyle": "<string>",
  "primaryColorHex": "<string>",
  "secondaryColorHex": "<string>",
  "lightModeLogoUrl": "<string>",
  "lightModeAltLogoUrl": "<string>",
  "darkModeLogoUrl": "<string>",
  "darkModeAltLogoUrl": "<string>",
  "faviconUrl": "<string>",
  "theme": "<string>",
  "subdomain": "<string>",
  "customDomain": "<string>",
  "apiConversationUrl": "<string>",
  "userId": "<string>",
  "cnpj": "<string>",
  "isActive": true,
  "name": "<string>",
  "description": "<string>",
  "safetyPlan": "<string>",
  "adminId": "<string>",
  "customerId": "<string>",
  "subscriptionId": "<string>",
  "institutionPlan": {
    "id": "<string>",
    "institutionId": "<string>",
    "unitiesLimit": 123,
    "botsLimit": 123,
    "widgetsLimit": 123,
    "knowledgeBasesLimit": 123,
    "pluginsLimit": 123,
    "vectorsLimit": 123,
    "createdAt": {},
    "updatedAt": {}
  }
}

​
Parâmetros

​
id
string
ID da instituição

​
Descrição da Resposta

O endpoint retorna uma resposta em formato JSON com a confirmação da solicitação.
​
id
string
Identificador único (opcional).
​
institutionToolzzId
number
required
ID da instituição no sistema Toolzz.
​
aiDefaultModel
string
required
Modelo de IA padrão utilizado pela instituição.
​
chatStyle
string
required
Configuração de estilo da interface do chat.
​
primaryColorHex
string
required
Cor primária em formato HEX.
​
secondaryColorHex
string
required
Cor secundária em formato HEX.
​
lightModeLogoUrl
string
required
URL do logo para o modo claro.
​
lightModeAltLogoUrl
string
URL do logo alternativo para o modo claro (opcional).
​
darkModeLogoUrl
string
required
URL do logo para o modo escuro.
​
darkModeAltLogoUrl
string
URL do logo alternativo para o modo escuro (opcional).
​
faviconUrl
string
required
URL do favicon.
​
theme
string
required
Configuração de tema do sistema.
​
subdomain
string
required
Subdomínio associado à instituição.
​
customDomain
string
Domínio personalizado associado à instituição (opcional).
​
apiConversationUrl
string
URL do endpoint de conversação da API (opcional).
​
userId
uuid
required
Identificador do usuário associado.
​
cnpj
string
required
CNPJ (Cadastro Nacional da Pessoa Jurídica) da instituição.
​
isActive
boolean
required
Indica se a instituição está ativa.
​
name
string
required
Nome da instituição.
​
description
string
required
Descrição da instituição.
​
safetyPlan
string
required
Plano de segurança associado à instituição.
​
adminId
uuid
required
ID do administrador associado à instituição.
​
customerId
uuid
required
ID do cliente associado à instituição.
​
subscriptionId
uuid
required
ID do plano de assinatura da instituição.
​
institutionPlan
InstitutionPlan
required
Detalhes do plano da instituição.

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