Get Institution

Endpoint used to fetch an institution by its ID.

Request Example

curl --request GET \
  --url https://chat.api.toolzz.com.br/api/v1/institution/id/{institutionId} \
  --header 'Authorization: Bearer TOKEN_HERE'

Response Example

{
    "id": "uuid",
    "subdomain": "<string>",
    "customDomain": null,
    "userId": "uuid",
    "cnpj": null,
    "isActive": true,
    "manualPayment": false,
    "name": "<string>",
    "description": "<string>",
    "safetyPlan": false,
    "adminId": "uuid",
    "customerId": "<string>",
    "subscriptionId": "<string>",
    "institutionPlan": {
        "unitiesLimit": 123,
        "botsLimit": 123,
        "widgetsLimit": 123,
        "knowledgeBasesLimit": 123,
        "pluginsLimit": 123,
        "vectorsLimit": 123,
        "usedVoiceSeconds": "<string>",
        "isMagic": true,
        "hasMonetizationAddon": true,
        "hasAnalyticsAddon": true,
        "hasMultiAddon": true,
        "hasVoiceAddon": true,
        "id": "uuid",
        "createdAt": "<string>",
        "updatedAt": "<string>",
        "institutionId": "uuid"
    },
    "indexServiceId": "uuid",
    "indexService": {
        "indexCounter": 123,
        "id": "uuid",
        "name": "<string>",
        "adminKey": "<string>",
        "searchKey": "<string>",
        "createdAt": "<string>",
        "updatedAt": "<string>"
    },
    "onboardingForm": {
        "id": "uuid",
        "userId": "uuid",
        "institutionId": "uuid",
        "companySize": null,
        "department": null,
        "role": null,
        "version": 123,
        "createdAt": "<string>",
        "updatedAt": "<string>"
    }
}

Request description

Access Token

Parameter	Type	Description	Required
`Authorization`	String	Access token (“Bearer” must be before the token)	Yes

URL Parameters

Parameter	Type	Description	Required
`institutionId`	UUID	Unique institution identifier.	Yes

Response description

Key	Type	Description
`id`	UUID	Unique identifier of the institution.
`subdomain`	String	Subdomain assigned to the institution on the platform.
`customDomain`	String	Custom domain configured by the client (null if none).
`userId`	UUID	Identifier of the account owner user.
`cnpj`	String	National Registry of Legal Entities of the institution (CNPJ).
`isActive`	Boolean	Institution account activation status.
`manualPayment`	Boolean	Defines if the payment method is processed manually.
`name`	String	Official name of the institution.
`description`	String	Brief description of the institution and its purpose.
`safetyPlan`	Boolean	Indicates if the advanced security plan is active.
`adminId`	UUID	Identifier of the main administrator.
`customerId`	String	Customer identifier in the payment provider (e.g., Stripe).
`subscriptionId`	String	Identifier of the active plan subscription.
`institutionPlan`	Object	Object containing the limits and features of the contracted plan.
`institutionPlan.unitiesLimit`	Number	Maximum limit of allowed organizational units.
`institutionPlan.botsLimit`	Number	Maximum limit of bots that can be created.
`institutionPlan.widgetsLimit`	Number	Maximum limit of configurable widgets.
`institutionPlan.knowledgeBasesLimit`	Number	Limit of allowed knowledge bases (RAG).
`institutionPlan.pluginsLimit`	Number	Limit of integrable plugins.
`institutionPlan.vectorsLimit`	Number	Maximum quantity of vectors (AI data storage).
`institutionPlan.isMagic`	Boolean	Defines if advanced automation features are enabled.
`institutionPlan.hasVoiceAddon`	Boolean	Indicates if voice support is included in the plan.
`indexService`	Object	Metadata of the indexing and data search service.
`indexService.indexCounter`	Number	Counter of indices processed by the service.
`indexService.adminKey`	String	Administrative key for managing the search service.
`indexService.searchKey`	String	Public key for performing search queries.
`onboardingForm`	Object	Data collected during the user onboarding process.
`onboardingForm.companySize`	String	Company size informed during onboarding.
`onboardingForm.department`	String	Department of the user responsible for the account.

Security

To access this endpoint, it is necessary to send a valid access token through the authorization header (Authorization) of the request. Additionally, the API is protected by other security measures to safeguard user data.

To access your access token, follow these steps:

Log in to the ToolzzAI platform
Click on “Settings”
Click on “Access Token”
Copy the access token

Access token page