Get Integrations

Endpoint used to get integrations.

Request Example

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

Response Example

[
  {
    "integrations": {
      "id": "uuid",
      "name": "<string>",
      "iconId": "uuid",
      "type": "<string>",
      "status": true,
      "validationEndpoint": "<url>",
      "slug": "<string>",
      "form": [
        {
          "name": "<string>",
          "type": "<string>",
          "label": "<string>",
          "maxLenght": "<string>",
          "required": true,
          "descrition": "<string>"
        }
      ],
      "createdAt": "ISO8601_DATETIME",
      "updatedAt": "ISO8601_DATETIME"
    },
    "icon": {
      "id": "uuid",
      "institutionId": "uuid",
      "type": "<string>",
      "fileName": "<string>",
      "internalStorageUrl": "<url>",
      "url": "<url>",
      "maskName": "<string>",
      "createdAt": "ISO8601_DATETIME",
      "updatedAt": "ISO8601_DATETIME",
      "extension": "<string>",
      "size": 123,
      "numberWords": null
    }
  }
]

---

Request description

Access Token

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

---

Response description

Key	Type	Description
integrations	Object	Object containing technical and configuration data of the integration provider.
integrations.id	UUID	Unique identifier of the integration in the system.
integrations.name	String	Commercial name of the service (e.g., Gemini, OpenAI, Stripe).
integrations.iconId	UUID	Unique identifier of the icon associated with this integration.
integrations.type	String	Integration category (e.g., llm, monetization, voice, phone).
integrations.status	Boolean	Indicates if the integration is active and available for use.
integrations.validationEndpoint	URL	Endpoint used to validate the authenticity of the provided credentials.
integrations.slug	String	Friendly textual identifier (without spaces or special characters).
integrations.form	Array	List of fields required for the integration configuration form.
integrations.form[].name	String	Technical field name (key to be sent in the creation request).
integrations.form[].type	String	Data type expected in the field (e.g., string, text, password).
integrations.form[].label	String	Label/Title of the field for user interface display.
integrations.form[].maxLenght	String	Maximum allowed characters for the field.
integrations.form[].required	Boolean	Defines if the field completion is mandatory for the integration to work.
integrations.form[].descrition	String	Help text or tip about what should be filled in the field.
integrations.createdAt	String	Date and time the integration record was created.
icon	Object	Detailed metadata of the icon image file.
icon.id	UUID	Unique identifier of the icon file.
icon.institutionId	UUID	Identifier of the institution owning the icon (can be null if global).
icon.type	String	Icon category within the file system.
icon.fileName	String	Original image file name.
icon.url	URL	Direct public link to view or download the image.
icon.extension	String	File format/extension (e.g., png, svg, jpeg).
icon.size	Number	Image file size in bytes.

---

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