Get Units

Endpoint used to fetch all units of the institution.

Request Example

curl --request GET \
  --url https://chat.api.toolzz.com.br/api/v1/unity/ \
  --header 'Authorization: Bearer TOKEN_HERE'

Response Example

{
    "items": [
        {
            "id": "uuid",
            "institutionId": "uuid",
            "name": "<string>",
            "isActivated": true,
            "credentialProjectId": "uuid"
        }
    ],
    "unityCount": 123,
    "activeCount": 123,
    "unityLimit": 123
}

---

Request description

Access Token

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

---

Response description

Key	Type	Description
items	Array	List containing the configuration objects of the units.
items[].id	UUID	Unique unit identifier.
items[].institutionId	UUID	Identifier of the institution the unit belongs to.
items[].name	String	Unit identification name (e.g., Commercial, HR, etc).
items[].isActivated	Boolean	Indicates if the unit is active in the system.
items[].credentialProjectId	UUID	ID of the credentials project linked to this unit.
unityCount	Number	Total number of registered units.
activeCount	Number	Number of units that are currently active.
unityLimit	Number	Maximum limit of units allowed by the institution’s plan.

---

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:

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