> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ryzeapi.cloud/llms.txt
> Use this file to discover all available pages before exploring further.

# Status / info

> Read the current state of the Chatwoot integration

**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

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET "https://ryzeapi.cloud/api/chatwoot/list/suporte" \
    -H "token: $Token_Account"
  ```

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

  ```python Python theme={null}
  import os, requests

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

  ```go Go theme={null}
  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)
  }
  ```
</CodeGroup>

## Success response

```json 200 OK theme={null}
{
  "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",
  "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.                                                                                                                      |
| `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.                                     |

<Warning>
  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.
</Warning>

<Note>
  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`.
</Note>

## Path parameters

<ParamField path="instance" type="string" required>
  Instance name (e.g., `suporte`).
</ParamField>

## Headers

<ParamField header="token" type="string" required>
  `TokenAccount` or `TokenInstance`.
</ParamField>

## Behavior

<Steps>
  <Step title="Read local data">
    Queries the `chatwoot_integrations` table. This step is fast and always works.
  </Step>

  <Step title="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.
  </Step>

  <Step title="Overwrite volatile fields">
    When the current state is available, `status` and `last_error` are replaced with the live values.
  </Step>

  <Step title="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`.
  </Step>
</Steps>

## Errors

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

<Tip>
  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`](/en/api/chatwoot/activate) usually fixes it.
</Tip>

## Next

<CardGroup cols={2}>
  <Card title="Reactivate / update" icon="plug" href="/en/api/chatwoot/activate">
    Use `POST /api/chatwoot/set/:instance` to fix credentials or flags.
  </Card>

  <Card title="Deactivate" icon="power-off" href="/en/api/chatwoot/deactivate">
    Remove the integration.
  </Card>
</CardGroup>