Get Discord Integration

Endpoint used to get a Discord integration.

Request Example

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

Response Example

{
  "id": "uuid",
  "connectionStatus": "connected",
  "botClientId": "<string_digits>",
  "guildName": "<string>",
  "isActive": true,
  "channelsDetail": [
    {
      "id": "<string_digits>",
      "name": "<string>"
    }
  ],
  "lastConnectedAt": "2026-04-17 12:26:14.14",
  "updatedAt": "2026-04-17 12:26:14.14"
}

---

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
integrationId	String	Discord integration ID	Yes

Response description

Key	Type	Description
id	UUID	Unique identifier of the configuration in the database.
title	String	Title or name assigned to the integration.
connectionStatus	String	Current status of the connection (e.g., connected, disconnected).
isActive	Boolean	Indicates if the integration is enabled and functional.
botId	UUID	Bot identifier within the Toolzz AI platform.
botClientId	String	Bot application ID (Client ID) provided by Discord.
botToken	String	Bot access token (usually masked).
isTokenMasked	Boolean	Confirms if the token is being displayed with a security mask.
unitId	UUID	Organizational unit identifier.
guildId	String	Snowflake ID of the server (Guild) on Discord.
guildName	String	Discord server name.
channelIds[]	Array[Str]	List of IDs of the monitored channels for interaction.
channelsDetail[]	Array[Obj]	List of objects with basic channel details:
channelsDetail[].id	String	Channel Snowflake ID.
channelsDetail[].name	String	Visible channel name on Discord.
scope	String	Monitoring scope (e.g., all for full reading).
permissions	String	Numeric string of configured permissions.
autoReplyOnMention	Boolean	Defines if the bot responds when mentioned.
threadAutoCreate	Boolean	Defines if the bot manages conversations via threads.
welcomeMessage	String	Configured message for initial greetings.
lastConnectedAt	String	Most recent connection date and time (ISO 8601).
lastDisconnectedAt	String/Null	Last disconnection date and time.
lastConnectionErrorCode	String/Null	Error code if the connection fails.
lastConnectionErrorMessage	String/Null	Description of the error in case of connection failure.
createdAt	String	Configuration creation date.
updatedAt	String	Date of the last data or connection status update.
deletedAt	String/Null	Logical removal date, if applicable.

---

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