List Inboxes

Endpoint used to list inboxes of Toolzz Chat.

Request Example

curl --request POST \
  --url https://converflow.api.prod.toolzz.media/api/v1/chat/inboxes \
  --header 'Authorization: Bearer TOKEN_HERE' \
  --header 'Content-Type: application/json' \
  --data '{
    "infisicalReference": {
        "secretName": "<secretId>"
    },
    "unitId": "uuid"
}'

Response Example

{
    "data": [
        {
            "id": 123,
            "name": "<string>"
        }
    ]
}

---

Request description

Access Token

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

Body Parameters

Key	Type	Description	Required
infisicalReference	Object	Object containing the pointing data for the secrets vault.	Yes
infisicalReference.secretName	String	Secret ID stored in Infisical.	Yes
unitId	UUID	Unique unit identifier.	Yes

Note: The secretName is the secretId that can be found in the response of the endpoint Get Credentials by Integration.

Response description

Key	Type	Description
data[]	Array	List of objects containing the inboxes linked to the unit.
id	Number	Unique numeric identifier of the inbox.
name	String	Inbox name.

---

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