Status / info

GET

api

chatwoot

list

:instance

Status / info

curl --request GET \
  --url https://api.example.com/api/chatwoot/list/:instance \
  --header 'token: <token>'

const options = {method: 'GET', headers: {token: '<token>'}};

fetch('https://api.example.com/api/chatwoot/list/:instance', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

Auth: TokenAccount or TokenInstance • Rate limit: Global (100/min) • Idempotent: yes

Description

Returns the local status of the Chatwoot integration and complements it with the current state (best-effort). This response includes the chatwoot_api_token in plaintext and the behaviour flags (sign_messages, ignore_groups, start_as_pending, reopen_resolved).

Example

curl -X GET "https://ryzeapi.cloud/api/chatwoot/list/suporte" \
  -H "token: $Token_Account"

await fetch("https://ryzeapi.cloud/api/chatwoot/list/suporte", {
  method: "GET",
  headers: {
    "token": process.env.Token_Account
  }
});

import os, requests

requests.get(
    "https://ryzeapi.cloud/api/chatwoot/list/suporte",
    headers={
        "token": os.environ["Token_Account"]
    }
)

package main

import (
    "net/http"
    "os"
)

func main() {
    req, _ := http.NewRequest("GET", "https://ryzeapi.cloud/api/chatwoot/list/suporte", nil)
    req.Header.Set("token", os.Getenv("Token_Account"))
    http.DefaultClient.Do(req)
}

Success response

200 OK

{
  "instance_name": "suporte",
  "status": "active",
  "bridge_integration_id": "int_xyz789abc",
  "chatwoot_base_url": "https://chatwoot.example.com",
  "chatwoot_account_id": 5,
  "chatwoot_api_token": "sk_live_abc123...",
  "chatwoot_inbox_id": 42,
  "chatwoot_inbox_name": "WhatsApp - Orion",
  "webhook_url": "https://bridge.ryzeapi.cloud/v1/chatwoot/webhook/int_xyz789abc",
  "last_error": "",
  "created_at": "2026-04-20T10:15:30Z",
  "sign_messages": true,
  "ignore_groups": false,
  "start_as_pending": false,
  "reopen_resolved": true
}

Field	Description
`instance_name`	Instance name.
`status`	`active` / `paused` / `error`. When available, reflects the current state.
`bridge_integration_id`	Internal integration ID.
`chatwoot_base_url`	URL of the Chatwoot installation.
`chatwoot_account_id`	Numeric ID of the Chatwoot account.
`chatwoot_api_token`	API token (`access_token`) of the Chatwoot account, in plaintext. Comes from the decrypted local row. See the warning below.
`chatwoot_inbox_id`	ID of the inbox created in Chatwoot (filled in after the first `list` that manages to sync).
`chatwoot_inbox_name`	Inbox name.
`webhook_url`	Webhook URL (API channel) Chatwoot should call for this integration. Present when the integration is reachable. Useful in webhook-only mode to paste into Chatwoot.
`last_error`	Last error message from the integration. Empty when healthy.
`created_at`	RFC 3339 timestamp when the integration was created.
`sign_messages`	Prefixes every message sent by an agent with `Name:` (WhatsApp bold).
`ignore_groups`	Does not route group events to Chatwoot.
`start_as_pending`	Creates new conversations as `pending` instead of `open`.
`reopen_resolved`	Reopens a `resolved` conversation when a new message arrives, instead of creating a new one.

The chatwoot_api_token is returned in plaintext in this response (it is stored encrypted at rest). Since this token usually has broad access to the Chatwoot account, treat the response as sensitive: avoid logging it or caching it on the client.

The sign_messages / ignore_groups / start_as_pending / reopen_resolved flags are persisted locally and reflect the last set. They are always returned, including as false.

Path parameters

string

required

Instance name (e.g., suporte).

Headers

string

required

TokenAccount or TokenInstance.

Behavior

Read local data

Queries the chatwoot_integrations table. This step is fast and always works.

Complement with the current state (best-effort)

RyzeAPI tries to fetch the current state of the integration with a 10s timeout. On network failure, it falls back to local data.

Overwrite volatile fields

When the current state is available, status and last_error are replaced with the live values.

Backfill of inbox_id

If the inbox_id became available and the local one is still 0, the database is updated (SetInboxID), useful for eventual-consistency cases right after set.

Errors

HTTP	`error.message`
404	`instance not found`
404	`no chatwoot integration for this instance`
503	`integration gateway not configured`

If last_error is non-empty, inspect the message, it usually indicates that Chatwoot dropped the session (token rotated, inbox manually removed, etc.). Reactivating with POST /api/chatwoot/set/:instance usually fixes it.

Reactivate / update

Use POST /api/chatwoot/set/:instance to fix credentials or flags.

Deactivate

Remove the integration.

Introduction

Instance

Events

Messages

Calls

Groups

Communities

Newsletter

Profile

Chat

Chatwoot

Typebot

Observability

Description

Example

Success response

Path parameters

Headers

Behavior

Errors

Next

Reactivate / update

Deactivate

​Description

​Example

​Success response

​Path parameters

​Headers

​Behavior

​Errors

​Next

Reactivate / update

Deactivate

Description

Example

Success response

Path parameters

Headers

Behavior

Errors

Next