Get Toolzz Chat Integration by Unit

Endpoint used to get Toolzz Chat integrations by unit.

Request Example

curl --request GET \
  --url https://converflow.api.prod.toolzz.media/api/v1/chat/integration/unit/{unitId} \
  --header 'Authorization: Bearer TOKEN_HERE'

Response Example

{
    "data": [
        {
            "id": "uuid",
            "title": "<string>",
            "isActive": true,
            "unitId": "uuid",
            "accountId": 1,
            "inboxId": 0,
            "teamId": 0,
            "activeBotIds": [],
            "handoffAction": "<string>",
            "escalationNotice": "<string>",
            "keepHistory": true,
            "sendInitialMessage": true,
            "infisicalReference": {
                "environment": "prod",
                "path": "/",
                "projectId": "uuid",
                "secretName": "uuid"
            }
        }
    ]
}

---

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
unitId	String	Unit ID	Yes

Response description

Key	Type	Description
data[]	Array	List of objects containing the transfer (handoff) settings.
data[].id	UUID	Unique identifier of the handoff rule in the database.
data[].title	String	Identifier name of the configuration (e.g., “toolzz-bea”).
data[].isActive	Boolean	Indicates if the transfer rule is active.
data[].unitId	UUID	Unique identifier of the owning organizational unit.
data[].accountId	Number	ID of the organizational account in the human chat provider.
data[].inboxId	Number	ID of the target inbox for the ticket.
data[].teamId	Number	ID of the target team/department (optional in some rules).
data[].activeBotIds	Array	List of IDs of bots currently using this rule.
data[].handoffAction	String	The logical trigger or prompt that instructs the AI to transfer.
data[].escalationNotice	String	Message seen by the client during the transfer.
data[].keepHistory	Boolean	Defines if the conversation history with the AI will be maintained for the human.
data[].sendInitialMessage	Boolean	Defines if an automatic message is triggered when starting the handoff.
data[].infisicalReference	Object	Security metadata of the linked credential:
infisicalReference.secretName	String	ID of the secret/key in the Infisical vault.
infisicalReference.projectId	UUID	Project ID in the secrets vault.
infisicalReference.environment	String	Execution environment (e.g., prod).
infisicalReference.path	String	Directory path in the vault.

---

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