GET
/
api
/
v1
/
institution
/
id
/
{id}
Get Institution
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": {}
  }
}

​
Parameters

​
id
string
Institution Id

​
Response Description

The endpoint returns a response in JSON format with a confirmation response to the request.
​
id
string
Optional unique identifier.
​
institutionToolzzId
number
required
ID of the institution in the Toolzz system.
​
aiDefaultModel
string
required
Default AI model used for the institution.
​
chatStyle
string
required
Style configuration for the chat interface.
​
primaryColorHex
string
required
Primary color in HEX format.
​
secondaryColorHex
string
required
Secondary color in HEX format.
​
lightModeLogoUrl
string
required
URL for the logo in light mode.
​
lightModeAltLogoUrl
string
URL for the alternative logo in light mode (optional).
​
darkModeLogoUrl
string
required
URL for the logo in dark mode.
​
darkModeAltLogoUrl
string
URL for the alternative logo in dark mode (optional).
​
faviconUrl
string
required
URL for the favicon.
​
theme
string
required
Theme configuration for the system.
​
subdomain
string
required
Subdomain associated with the institution.
​
customDomain
string
Custom domain associated with the institution (optional).
​
apiConversationUrl
string
URL for the API conversation endpoint (optional).
​
userId
uuid
required
Identifier of the associated user.
​
cnpj
string
required
CNPJ (Cadastro Nacional da Pessoa Jurídica) of the institution.
​
isActive
boolean
required
Indicates whether the institution is active.
​
name
string
required
Name of the institution.
​
description
string
required
Description of the institution.
​
safetyPlan
string
required
Safety plan associated with the institution.
​
adminId
uuid
required
ID of the administrator associated with the institution.
​
customerId
uuid
required
ID of the customer associated with the institution.
​
subscriptionId
uuid
required
ID of the subscription plan for the institution.
​
institutionPlan
InstitutionPlan
required
Institution plan details.

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