Skip to content

Get Unit by ID

Endpoint used to fetch a unit by its ID.

Terminal window
curl --request GET \
--url https://chat.api.toolzz.com.br/api/v1/unity/{unityId} \
--header 'Authorization: Bearer TOKEN_HERE'
{
"id": "uuid",
"institutionId": "uuid",
"name": "<string>",
"isActivated": true,
"credentialProjectId": "uuid"
}

ParameterTypeDescriptionRequired
AuthorizationStringAccess token (“Bearer” must be before the token)Yes
ParameterTypeDescriptionRequired
unityIdUUIDUnique identifier of the unit.Yes

KeyTypeDescription
idUUIDUnique identifier of the organizational unit.
institutionIdUUIDIdentifier of the institution owning this unit.
nameStringUnit identification name (e.g., “AI”, “Marketing”, etc).
isActivatedBooleanActivation status of the unit in the system.
credentialProjectIdUUIDIdentifier of the credentials project associated with this specific unit.

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:

  1. Log in to the ToolzzAI platform
  2. Click on “Settings”
  3. Click on “Access Token”
  4. Copy the access token

Access token page